diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 37e84a960..f260792a5 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -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`-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`. -- **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` (only applied for ``null``). - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool`. - **TYPE_INT** = **2** --- Variable is of type :ref:`int`. -- **TYPE_REAL** = **3** --- Variable is of type :ref:`float`/real. +- **TYPE_REAL** = **3** --- Variable is of type :ref:`float` (real). - **TYPE_STRING** = **4** --- Variable is of type :ref:`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. diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index f6176d499..8ce8a23f4 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -17,13 +17,13 @@ Axis-Aligned Bounding Box. Properties ---------- -+-------------------------------+-----------------------------------------------+ -| :ref:`Vector3` | :ref:`end` | -+-------------------------------+-----------------------------------------------+ -| :ref:`Vector3` | :ref:`position` | -+-------------------------------+-----------------------------------------------+ -| :ref:`Vector3` | :ref:`size` | -+-------------------------------+-----------------------------------------------+ ++-------------------------------+-----------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`end` | Vector3( 0, 0, 0 ) | ++-------------------------------+-----------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`position` | Vector3( 0, 0, 0 ) | ++-------------------------------+-----------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`size` | Vector3( 0, 0, 0 ) | ++-------------------------------+-----------------------------------------------+--------------------+ Methods ------- @@ -89,18 +89,30 @@ Property Descriptions - :ref:`Vector3` **end** ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ + Ending corner. .. _class_AABB_property_position: - :ref:`Vector3` **position** ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ + Beginning corner. .. _class_AABB_property_size: - :ref:`Vector3` **size** ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ + Size from position to end. Method Descriptions diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 0e529295d..802dc23fe 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -21,13 +21,13 @@ Base dialog for user notification. Properties ---------- -+-----------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dialog_autowrap` | -+-----------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dialog_hide_on_ok` | -+-----------------------------+-------------------------------------------------------------------------+ -| :ref:`String` | :ref:`dialog_text` | -+-----------------------------+-------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`dialog_autowrap` | false | ++-----------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`dialog_hide_on_ok` | true | ++-----------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`dialog_text` | "" | ++-----------------------------+-------------------------------------------------------------------------+-------+ Methods ------- @@ -71,11 +71,13 @@ Property Descriptions - :ref:`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` **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` 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` 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` 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` 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` **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` 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: diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 46978807f..7d3c60f78 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -19,25 +19,25 @@ Sprite node that can use multiple textures for animation. Properties ---------- -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`animation` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`centered` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_h` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_v` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`frame` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`SpriteFrames` | :ref:`frames` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+-----------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`String` | :ref:`animation` | "default" | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`centered` | true | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`flip_h` | false | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`flip_v` | false | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`frame` | 0 | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`SpriteFrames` | :ref:`frames` | null | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`playing` | false | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`speed_scale` | 1.0 | ++-----------------------------------------+---------------------------------------------------------------+-----------------+ Methods ------- @@ -77,11 +77,13 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **frames** -+----------+--------------------------+ -| *Setter* | set_sprite_frames(value) | -+----------+--------------------------+ -| *Getter* | get_sprite_frames() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_sprite_frames(value) | ++-----------+--------------------------+ +| *Getter* | get_sprite_frames() | ++-----------+--------------------------+ The :ref:`SpriteFrames` resource containing the animation(s). @@ -149,11 +161,13 @@ The :ref:`SpriteFrames` resource containing the animation(s) - :ref:`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` **playing** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, the :ref:`animation` is currently playing. .. _class_AnimatedSprite_property_speed_scale: - :ref:`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. diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index c0cad8d42..b121a7697 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -19,15 +19,15 @@ Brief Description Properties ---------- -+-----------------------------------------+-------------------------------------------------------------+ -| :ref:`String` | :ref:`animation` | -+-----------------------------------------+-------------------------------------------------------------+ -| :ref:`int` | :ref:`frame` | -+-----------------------------------------+-------------------------------------------------------------+ -| :ref:`SpriteFrames` | :ref:`frames` | -+-----------------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+-----------------------------------------+-------------------------------------------------------------+ ++-----------------------------------------+-------------------------------------------------------------+-----------+ +| :ref:`String` | :ref:`animation` | "default" | ++-----------------------------------------+-------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`frame` | 0 | ++-----------------------------------------+-------------------------------------------------------------+-----------+ +| :ref:`SpriteFrames` | :ref:`frames` | null | ++-----------------------------------------+-------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`playing` | false | ++-----------------------------------------+-------------------------------------------------------------+-----------+ Methods ------- @@ -61,11 +61,13 @@ Property Descriptions - :ref:`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` **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` **frames** -+----------+--------------------------+ -| *Setter* | set_sprite_frames(value) | -+----------+--------------------------+ -| *Getter* | get_sprite_frames() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_sprite_frames(value) | ++-----------+--------------------------+ +| *Getter* | get_sprite_frames() | ++-----------+--------------------------+ The :ref:`SpriteFrames` resource containing the animation(s). @@ -97,6 +103,10 @@ The :ref:`SpriteFrames` resource containing the animation(s) - :ref:`bool` **playing** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, the :ref:`animation` is currently playing. Method Descriptions diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index ab3a1ca79..ac0847e9d 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -19,11 +19,11 @@ Proxy texture for simple frame-based animations. Properties ---------- -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`fps` | -+---------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`frames` | -+---------------------------+------------------------------------------------------+ ++---------------------------+------------------------------------------------------+-----+ +| :ref:`float` | :ref:`fps` | 4.0 | ++---------------------------+------------------------------------------------------+-----+ +| :ref:`int` | :ref:`frames` | 1 | ++---------------------------+------------------------------------------------------+-----+ Methods ------- @@ -61,13 +61,15 @@ Property Descriptions - :ref:`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` 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`). 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` 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`). 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` **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`, you need to set this value for the animation to take new frames into account. The maximum number of frames is :ref:`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`, you need to set this value for the animation to take new frames into account. The maximum number of frames is :ref:`MAX_FRAMES`. Method Descriptions ------------------- diff --git a/classes/class_animation.rst b/classes/class_animation.rst index e3cd490b6..169e698c4 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -19,13 +19,13 @@ Contains data used to animate everything in the engine. Properties ---------- -+---------------------------+------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+------------------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+---------------------------+------------------------------------------------+ -| :ref:`float` | :ref:`step` | -+---------------------------+------------------------------------------------+ ++---------------------------+------------------------------------------------+-------+ +| :ref:`float` | :ref:`length` | 1.0 | ++---------------------------+------------------------------------------------+-------+ +| :ref:`bool` | :ref:`loop` | false | ++---------------------------+------------------------------------------------+-------+ +| :ref:`float` | :ref:`step` | 0.1 | ++---------------------------+------------------------------------------------+-------+ Methods ------- @@ -251,11 +251,13 @@ Property Descriptions - :ref:`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` **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` **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` **track_get_interpolation_loop_wrap** **(** :ref:`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: diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index e0d7b72c0..7ca4e90e6 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -19,9 +19,9 @@ Blends two animations additively inside of an :ref:`AnimationNodeBlendTree` | :ref:`sync` | -+-------------------------+----------------------------------------------------+ ++-------------------------+----------------------------------------------------+-------+ +| :ref:`bool` | :ref:`sync` | false | ++-------------------------+----------------------------------------------------+-------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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`, forcing the blended animations to update every frame. diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index f970b9f85..6e6790287 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -19,9 +19,9 @@ Blends two of three animations additively inside of an :ref:`AnimationNodeBlendT Properties ---------- -+-------------------------+----------------------------------------------------+ -| :ref:`bool` | :ref:`sync` | -+-------------------------+----------------------------------------------------+ ++-------------------------+----------------------------------------------------+-------+ +| :ref:`bool` | :ref:`sync` | false | ++-------------------------+----------------------------------------------------+-------+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`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`, forcing the blended animations to update every frame. diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index bc766b8a3..1547004bf 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -19,9 +19,9 @@ Input animation to use in an :ref:`AnimationNodeBlendTree` | :ref:`animation` | -+-----------------------------+-------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`animation` | "" | ++-----------------------------+-------------------------------------------------------------------+----+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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`. diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index afe0462e0..7466eed8d 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -19,9 +19,9 @@ Blends two animations linearly inside of an :ref:`AnimationNodeBlendTree` | :ref:`sync` | -+-------------------------+------------------------------------------------------+ ++-------------------------+------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`sync` | false | ++-------------------------+------------------------------------------------------+-------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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`, forcing the blended animations to update every frame. diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 82fbb8643..a7142ccf6 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -19,9 +19,9 @@ Blends two of three animations linearly inside of an :ref:`AnimationNodeBlendTre Properties ---------- -+-------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`sync` | -+-------------------------+------------------------------------------------------+ ++-------------------------+------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`sync` | false | ++-------------------------+------------------------------------------------------+-------+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`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`, forcing the blended animations to update every frame. diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index 6aa412884..c9f006b96 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -19,15 +19,15 @@ Blends linearly between two of any number of :ref:`AnimationNode` | :ref:`max_space` | -+-----------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`min_space` | -+-----------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`snap` | -+-----------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`value_label` | -+-----------------------------+--------------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`max_space` | 1.0 | ++-----------------------------+--------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`min_space` | -1.0 | ++-----------------------------+--------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`snap` | 0.1 | ++-----------------------------+--------------------------------------------------------------------------+---------+ +| :ref:`String` | :ref:`value_label` | "value" | ++-----------------------------+--------------------------------------------------------------------------+---------+ Methods ------- @@ -66,11 +66,13 @@ Property Descriptions - :ref:`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`. @@ -78,11 +80,13 @@ The blend space's axis's upper limit for the points' position. See :ref:`add_ble - :ref:`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`. @@ -90,11 +94,13 @@ The blend space's axis's lower limit for the points' position. See :ref:`add_ble - :ref:`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` **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. diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index e5a275683..6006884b2 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -19,21 +19,21 @@ Blends linearly between three :ref:`AnimationNode` of any t Properties ---------- -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_triangles` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`BlendMode` | :ref:`blend_mode` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`max_space` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`min_space` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`snap` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`x_label` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`y_label` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ ++------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`auto_triangles` | true | ++------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`BlendMode` | :ref:`blend_mode` | 0 | ++------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`max_space` | Vector2( 1, 1 ) | ++------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`min_space` | Vector2( -1, -1 ) | ++------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`snap` | Vector2( 0.1, 0.1 ) | ++------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`x_label` | "x" | ++------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`y_label` | "y" | ++------------------------------------------------------------+--------------------------------------------------------------------------------+---------------------+ Methods ------- @@ -106,11 +106,13 @@ Property Descriptions - :ref:`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` and :ref:`remove_blend_point`. @@ -118,11 +120,13 @@ If true, the blend space is triangulated automatically. The mesh updates every t - :ref:`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` constants. @@ -130,11 +134,13 @@ Controls the interpolation between animations. See :ref:`BlendMode` **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`. @@ -142,11 +148,13 @@ The blend space's X and Y axes' upper limit for the points' position. See :ref:` - :ref:`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`. @@ -154,11 +162,13 @@ The blend space's X and Y axes' lower limit for the points' position. See :ref:` - :ref:`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` **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` **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. diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index b26300cac..3944c6341 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------------+-------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`graph_offset` | -+-------------------------------+-------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`graph_offset` | Vector2( 0, 0 ) | ++-------------------------------+-------------------------------------------------------------------------+-----------------+ Methods ------- @@ -80,11 +80,13 @@ Property Descriptions - :ref:`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 ------------------- diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index ee47d786f..caf117d96 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -19,19 +19,19 @@ Brief Description Properties ---------- -+---------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`autorestart` | -+---------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`autorestart_delay` | -+---------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`autorestart_random_delay` | -+---------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fadein_time` | -+---------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fadeout_time` | -+---------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sync` | -+---------------------------+-----------------------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`autorestart` | false | ++---------------------------+-----------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`autorestart_delay` | 1.0 | ++---------------------------+-----------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`autorestart_random_delay` | 0.0 | ++---------------------------+-----------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`fadein_time` | 0.1 | ++---------------------------+-----------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`fadeout_time` | 0.1 | ++---------------------------+-----------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`sync` | false | ++---------------------------+-----------------------------------------------------------------------------------------------+-------+ Methods ------- @@ -64,61 +64,73 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **sync** -+----------+---------------------+ -| *Setter* | set_use_sync(value) | -+----------+---------------------+ -| *Getter* | is_using_sync() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_use_sync(value) | ++-----------+---------------------+ +| *Getter* | is_using_sync() | ++-----------+---------------------+ Method Descriptions ------------------- diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index b48ee526d..798df64e0 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -19,19 +19,19 @@ Brief Description Properties ---------- -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`advance_condition` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_advance` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`priority` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`SwitchMode` | :ref:`switch_mode` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`xfade_time` | -+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`advance_condition` | "" | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`auto_advance` | false | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`disabled` | false | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`priority` | 1 | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`SwitchMode` | :ref:`switch_mode` | 0 | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`xfade_time` | 0.0 | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ Signals ------- @@ -66,11 +66,13 @@ Property Descriptions - :ref:`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` that can be controlled from code (see `https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code `_). For example, if :ref:`AnimationTree.tree_root` is an :ref:`AnimationNodeStateMachine` and :ref:`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` **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`. @@ -94,11 +98,13 @@ Turn on the transition automatically when this state is reached. This works best - :ref:`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` or :ref:`auto_advance`. @@ -106,11 +112,13 @@ Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel< - :ref:`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` or :ref:`auto_advance`. @@ -118,11 +126,13 @@ Lower priority transitions are preferred when travelling through the tree via :r - :ref:`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` **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. diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index 2c636c10b..c34140055 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -19,139 +19,139 @@ Brief Description Properties ---------- -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_0/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_0/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_1/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_1/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_10/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_10/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_11/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_11/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_12/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_12/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_13/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_13/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_14/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_14/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_15/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_15/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_16/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_16/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_17/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_17/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_18/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_18/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_19/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_19/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_2/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_2/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_20/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_20/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_21/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_21/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_22/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_22/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_23/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_23/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_24/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_24/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_25/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_25/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_26/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_26/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_27/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_27/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_28/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_28/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_29/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_29/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_3/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_3/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_30/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_30/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_31/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_31/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_4/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_4/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_5/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_5/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_6/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_6/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_7/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_7/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_8/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_8/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_9/auto_advance` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_9/name` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`input_count` | -+-----------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`xfade_time` | -+-----------------------------+--------------------------------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_0/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_0/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_1/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_1/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_10/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_10/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_11/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_11/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_12/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_12/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_13/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_13/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_14/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_14/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_15/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_15/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_16/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_16/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_17/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_17/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_18/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_18/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_19/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_19/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_2/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_2/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_20/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_20/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_21/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_21/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_22/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_22/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_23/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_23/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_24/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_24/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_25/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_25/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_26/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_26/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_27/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_27/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_28/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_28/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_29/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_29/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_3/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_3/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_30/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_30/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_31/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_31/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_4/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_4/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_5/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_5/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_6/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_6/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_7/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_7/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_8/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_8/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`bool` | :ref:`input_9/auto_advance` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`String` | :ref:`input_9/name` | | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`input_count` | 0 | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`xfade_time` | 0.0 | ++-----------------------------+--------------------------------------------------------------------------------------------+-----+ Property Descriptions --------------------- @@ -800,19 +800,23 @@ Property Descriptions - :ref:`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` **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() | ++-----------+----------------------------+ diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 1c949f902..6008e0670 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -19,29 +19,29 @@ Container and player of :ref:`Animation` resources. Properties ---------- -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`assigned_animation` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`autoplay` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_animation` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`current_animation_length` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`current_animation_position` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`AnimationMethodCallMode` | :ref:`method_call_mode` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`playback_active` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`playback_default_blend_time` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`playback_speed` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`root_node` | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`String` | :ref:`assigned_animation` | | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`String` | :ref:`autoplay` | "" | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`String` | :ref:`current_animation` | "" | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`current_animation_length` | | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`current_animation_position` | | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`AnimationMethodCallMode` | :ref:`method_call_mode` | 0 | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`bool` | :ref:`playback_active` | | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`playback_default_blend_time` | 0.0 | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | 1 | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`float` | :ref:`playback_speed` | 1.0 | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ +| :ref:`NodePath` | :ref:`root_node` | NodePath("..") | ++------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------+ Methods ------- @@ -179,25 +179,29 @@ If playing, the current animation; otherwise, the animation last played. When se - :ref:`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` **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`. 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_property_current_animation_length: @@ -223,13 +227,15 @@ The position (in seconds) of the currently playing animation. - :ref:`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`. +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` **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` **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`. +The process notification in which to update animations. .. _class_AnimationPlayer_property_playback_speed: - :ref:`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` **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 ------------------- diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 69b339832..48a09a777 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -19,17 +19,17 @@ Brief Description Properties ---------- -+----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`active` | -+----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`anim_player` | -+----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`AnimationProcessMode` | :ref:`process_mode` | -+----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`root_motion_track` | -+----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`tree_root` | -+----------------------------------------------------------------------+--------------------------------------------------------------------------+ ++----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`active` | false | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`anim_player` | NodePath("") | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+ +| :ref:`AnimationProcessMode` | :ref:`process_mode` | 1 | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`root_motion_track` | NodePath("") | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+ +| :ref:`AnimationNode` | :ref:`tree_root` | null | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+--------------+ Methods ------- @@ -75,51 +75,61 @@ Property Descriptions - :ref:`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` **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` **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` **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` **tree_root** -+----------+----------------------+ -| *Setter* | set_tree_root(value) | -+----------+----------------------+ -| *Getter* | get_tree_root() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | null | ++-----------+----------------------+ +| *Setter* | set_tree_root(value) | ++-----------+----------------------+ +| *Getter* | get_tree_root() | ++-----------+----------------------+ Method Descriptions ------------------- diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index f279d6a45..826ee0073 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -19,15 +19,15 @@ Animation Player that uses a node graph for blending Animations. Properties ---------- -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`active` | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`base_path` | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`master_player` | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+ +| :ref:`bool` | :ref:`active` | false | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+ +| :ref:`NodePath` | :ref:`base_path` | NodePath("..") | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+ +| :ref:`NodePath` | :ref:`master_player` | NodePath("") | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+ +| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | 1 | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+----------------+ Methods ------- @@ -221,25 +221,29 @@ Property Descriptions - :ref:`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` **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` **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` 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` **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`. +The thread in which to update animations. Method Descriptions ------------------- diff --git a/classes/class_area.rst b/classes/class_area.rst index 641b39ae7..58aa4e7b2 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -19,43 +19,43 @@ General-purpose area node for detection and 3D physics influence. Properties ---------- -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio_bus_name` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio_bus_override` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_distance_scale` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gravity_point` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`gravity_vec` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`monitorable` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`monitoring` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`priority` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`reverb_bus_amount` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reverb_bus_enable` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`String` | :ref:`reverb_bus_name` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`reverb_bus_uniformity` | -+-----------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`SpaceOverride` | :ref:`space_override` | -+-----------------------------------------------+---------------------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`angular_damp` | 0.1 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`audio_bus_name` | "Master" | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`audio_bus_override` | false | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`gravity` | 9.8 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`gravity_distance_scale` | 0.0 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`gravity_point` | false | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`Vector3` | :ref:`gravity_vec` | Vector3( 0, -1, 0 ) | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`linear_damp` | 0.1 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`monitorable` | true | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`monitoring` | true | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`priority` | 0.0 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`reverb_bus_amount` | 0.0 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`reverb_bus_enable` | false | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`reverb_bus_name` | "Master" | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`reverb_bus_uniformity` | 0.0 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`SpaceOverride` | :ref:`space_override` | 0 | ++-----------------------------------------------+---------------------------------------------------------------------------+---------------------+ Methods ------- @@ -176,11 +176,13 @@ Property Descriptions - :ref:`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` **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` **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` **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`. @@ -224,11 +232,13 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different - :ref:`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` **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` **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` **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`). See also :ref:`space_override`. Default value: ``false``. +If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). See also :ref:`space_override`. .. _class_Area_property_gravity_vec: - :ref:`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`), 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` **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` **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` **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` **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` **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` **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` **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` **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` **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` for possible values. diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 8a24efbcd..1dca931e1 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -19,35 +19,35 @@ Brief Description Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio_bus_name` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio_bus_override` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_distance_scale` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gravity_point` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`gravity_vec` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`monitorable` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`monitoring` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`priority` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`SpaceOverride` | :ref:`space_override` | -+-------------------------------------------------+-----------------------------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`angular_damp` | 1.0 | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`String` | :ref:`audio_bus_name` | "Master" | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`audio_bus_override` | false | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`gravity` | 98.0 | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`gravity_distance_scale` | 0.0 | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`gravity_point` | false | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`gravity_vec` | Vector2( 0, 1 ) | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`linear_damp` | 0.1 | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`monitorable` | true | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`monitoring` | true | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`priority` | 0.0 | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ +| :ref:`SpaceOverride` | :ref:`space_override` | 0 | ++-------------------------------------------------+-----------------------------------------------------------------------------+-----------------+ Methods ------- @@ -168,11 +168,13 @@ Property Descriptions - :ref:`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` **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` **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` **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`. @@ -216,11 +224,13 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different - :ref:`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` **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` **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` **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`). See also :ref:`space_override`. Default value: ``false``. +If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). See also :ref:`space_override`. .. _class_Area2D_property_gravity_vec: - :ref:`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`), 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` **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` **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` **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` **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` **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` for possible values. diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 009a9976a..1c0114bce 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`BlendShapeMode` | :ref:`blend_shape_mode` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`custom_aabb` | -+-------------------------------------------------+--------------------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------+--------------------------+ +| :ref:`BlendShapeMode` | :ref:`blend_shape_mode` | 1 | ++-------------------------------------------------+--------------------------------------------------------------------+--------------------------+ +| :ref:`AABB` | :ref:`custom_aabb` | AABB( 0, 0, 0, 0, 0, 0 ) | ++-------------------------------------------------+--------------------------------------------------------------------+--------------------------+ Methods ------- @@ -192,23 +192,27 @@ Property Descriptions - :ref:`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` **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` 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` 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 ------------------- diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index f01290691..e9bb83633 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -19,9 +19,9 @@ An anchor point in AR space. Properties ---------- -+-----------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`anchor_id` | -+-----------------------+-------------------------------------------------------+ ++-----------------------+-------------------------------------------------------+---+ +| :ref:`int` | :ref:`anchor_id` | 1 | ++-----------------------+-------------------------------------------------------+---+ Methods ------- @@ -63,11 +63,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 5e4948ab1..12700ad7d 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -19,11 +19,11 @@ A spatial node representing a spatially-tracked controller. Properties ---------- -+---------------------------+-------------------------------------------------------------------+ -| :ref:`int` | :ref:`controller_id` | -+---------------------------+-------------------------------------------------------------------+ -| :ref:`float` | :ref:`rumble` | -+---------------------------+-------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`controller_id` | 1 | ++---------------------------+-------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`rumble` | 0.0 | ++---------------------------+-------------------------------------------------------------------+-----+ Methods ------- @@ -81,11 +81,13 @@ Property Descriptions - :ref:`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` **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` accordingly. diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 428ebd91e..5a99561b2 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -21,13 +21,13 @@ Base class for an AR/VR interface implementation. Properties ---------- -+-------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ar_is_anchor_detection_enabled` | -+-------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interface_is_initialized` | -+-------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interface_is_primary` | -+-------------------------+----------------------------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`ar_is_anchor_detection_enabled` | false | ++-------------------------+----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`interface_is_initialized` | false | ++-------------------------+----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`interface_is_primary` | false | ++-------------------------+----------------------------------------------------------------------------------------------------+-------+ Methods ------- @@ -131,11 +131,13 @@ Property Descriptions - :ref:`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` **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` **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? diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index d07b658dd..b5c14aeec 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -19,9 +19,9 @@ The origin point in AR/VR. Properties ---------- -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`world_scale` | -+---------------------------+-----------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------+-----+ +| :ref:`float` | :ref:`world_scale` | 1.0 | ++---------------------------+-----------------------------------------------------------+-----+ Description ----------- @@ -41,11 +41,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index a6b524c4e..a629d94b7 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -19,9 +19,9 @@ A tracked object. Properties ---------- -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`rumble` | -+---------------------------+------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`rumble` | 0.0 | ++---------------------------+------------------------------------------------------------+-----+ Methods ------- @@ -83,11 +83,13 @@ Property Descriptions - :ref:`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``. diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index efd9c95a6..26056ba74 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -19,11 +19,11 @@ The AR/VR server. Properties ---------- -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`ARVRInterface` | :ref:`primary_interface` | -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`world_scale` | -+-------------------------------------------+-----------------------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------------+------+ +| :ref:`ARVRInterface` | :ref:`primary_interface` | null | ++-------------------------------------------+-----------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`world_scale` | 1.0 | ++-------------------------------------------+-----------------------------------------------------------------------+------+ Methods ------- @@ -140,21 +140,25 @@ Property Descriptions - :ref:`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` **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. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 66a23fbdc..0b87e85d4 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -19,15 +19,15 @@ Packs multiple small textures in a single, bigger one. Helps to optimize video m Properties ---------- -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Texture` | :ref:`atlas` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`filter_clip` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`margin` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region` | -+-------------------------------+-------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`atlas` | null | ++-------------------------------+-------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`filter_clip` | false | ++-------------------------------+-------------------------------------------------------------+---------------------+ +| :ref:`Rect2` | :ref:`margin` | Rect2( 0, 0, 0, 0 ) | ++-------------------------------+-------------------------------------------------------------+---------------------+ +| :ref:`Rect2` | :ref:`region` | Rect2( 0, 0, 0, 0 ) | ++-------------------------------+-------------------------------------------------------------+---------------------+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`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` subtype. @@ -55,11 +57,13 @@ The texture that contains the atlas. Can be any :ref:`Texture` su - :ref:`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` **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`'s :ref:`Rect2.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`'s :ref:`Rect2.size` **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. diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index 3be615aa6..e682bb198 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -21,9 +21,9 @@ Increases or decreases the volume of the selected audio bus. Properties ---------- -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`volume_db` | -+---------------------------+---------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`volume_db` | 0.0 | ++---------------------------+---------------------------------------------------------------+-----+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 088a299b8..2f81e88e9 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -19,61 +19,61 @@ Adds a chorus audio effect. Properties ---------- -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dry` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/cutoff_hz` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/delay_ms` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/depth_ms` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/level_db` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/pan` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/rate_hz` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/cutoff_hz` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/delay_ms` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/depth_ms` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/level_db` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/pan` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/rate_hz` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/cutoff_hz` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/delay_ms` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/depth_ms` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/level_db` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/pan` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/rate_hz` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/cutoff_hz` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/delay_ms` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/depth_ms` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/level_db` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/pan` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/rate_hz` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`voice_count` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`wet` | -+---------------------------+------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`dry` | 1.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/1/cutoff_hz` | 8000.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/1/delay_ms` | 15.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/1/depth_ms` | 2.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/1/level_db` | 0.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/1/pan` | -0.5 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/1/rate_hz` | 0.8 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/2/cutoff_hz` | 8000.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/2/delay_ms` | 20.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/2/depth_ms` | 3.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/2/level_db` | 0.0 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/2/pan` | 0.5 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/2/rate_hz` | 1.2 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/3/cutoff_hz` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/3/delay_ms` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/3/depth_ms` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/3/level_db` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/3/pan` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/3/rate_hz` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/4/cutoff_hz` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/4/delay_ms` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/4/depth_ms` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/4/level_db` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/4/pan` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`voice/4/rate_hz` | | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`voice_count` | 2 | ++---------------------------+------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`wet` | 0.5 | ++---------------------------+------------------------------------------------------------------------------+--------+ Description ----------- @@ -87,11 +87,13 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **wet** -+----------+----------------+ -| *Setter* | set_wet(value) | -+----------+----------------+ -| *Getter* | get_wet() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | 0.5 | ++-----------+----------------+ +| *Setter* | set_wet(value) | ++-----------+----------------+ +| *Getter* | get_wet() | ++-----------+----------------+ The effect's processed signal. diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index c49b97684..f1176ae73 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -21,21 +21,21 @@ Reduces sounds that exceed a certain threshold level, smooths out the dynamics a Properties ---------- -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`attack_us` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`gain` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`mix` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`ratio` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`release_ms` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`sidechain` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`threshold` | -+-----------------------------+--------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`attack_us` | 20.0 | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`gain` | 0.0 | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`mix` | 1.0 | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`ratio` | 4.0 | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`release_ms` | 250.0 | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`sidechain` | "" | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`threshold` | 0.0 | ++-----------------------------+--------------------------------------------------------------------+-------+ Description ----------- @@ -59,23 +59,27 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **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` **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. diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 3ea6585c3..c3f600dae 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -21,33 +21,33 @@ Two tap delay and feedback options. Properties ---------- -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dry` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`feedback/active` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`feedback/delay_ms` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`feedback/level_db` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`feedback/lowpass` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tap1/active` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap1/delay_ms` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap1/level_db` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap1/pan` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tap2/active` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap2/delay_ms` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap2/level_db` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap2/pan` | -+---------------------------+-----------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`dry` | 1.0 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`bool` | :ref:`feedback/active` | false | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`feedback/delay_ms` | 340.0 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`feedback/level_db` | -6.0 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`feedback/lowpass` | 16000.0 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`bool` | :ref:`tap1/active` | true | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`tap1/delay_ms` | 250.0 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`tap1/level_db` | -6.0 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`tap1/pan` | 0.2 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`bool` | :ref:`tap2/active` | true | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`tap2/delay_ms` | 500.0 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`tap2/level_db` | -12.0 | ++---------------------------+-----------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`tap2/pan` | -0.4 | ++---------------------------+-----------------------------------------------------------------------------+---------+ Description ----------- @@ -61,155 +61,181 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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). diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 0f8239a07..8b774b660 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -21,17 +21,17 @@ Modify the sound to make it dirty. Properties ---------- -+----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`drive` | -+----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`keep_hf_hz` | -+----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`post_gain` | -+----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`pre_gain` | -+----------------------------------------------+--------------------------------------------------------------------+ ++----------------------------------------------+--------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`drive` | 0.0 | ++----------------------------------------------+--------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`keep_hf_hz` | 16000.0 | ++----------------------------------------------+--------------------------------------------------------------------+---------+ +| :ref:`Mode` | :ref:`mode` | 0 | ++----------------------------------------------+--------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`post_gain` | 0.0 | ++----------------------------------------------+--------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`pre_gain` | 0.0 | ++----------------------------------------------+--------------------------------------------------------------------+---------+ Enumerations ------------ @@ -74,59 +74,69 @@ Property Descriptions - :ref:`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` **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` **mode** -+----------+-----------------+ -| *Setter* | set_mode(value) | -+----------+-----------------+ -| *Getter* | get_mode() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_mode(value) | ++-----------+-----------------+ +| *Getter* | get_mode() | ++-----------+-----------------+ -Distortion type. Default value: :ref:`MODE_CLIP`. +Distortion type. .. _class_AudioEffectDistortion_property_post_gain: - :ref:`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` **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. diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index a881b7d84..3db57680f 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -21,15 +21,15 @@ Adds a filter to the audio bus. Properties ---------- -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`cutoff_hz` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`FilterDB` | :ref:`db` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`gain` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`resonance` | -+--------------------------------------------------+--------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`cutoff_hz` | 2000.0 | ++--------------------------------------------------+--------------------------------------------------------------+--------+ +| :ref:`FilterDB` | :ref:`db` | 0 | ++--------------------------------------------------+--------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`gain` | 1.0 | ++--------------------------------------------------+--------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`resonance` | 0.5 | ++--------------------------------------------------+--------------------------------------------------------------+--------+ Enumerations ------------ @@ -66,11 +66,13 @@ Property Descriptions - :ref:`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` **db** -+----------+---------------+ -| *Setter* | set_db(value) | -+----------+---------------+ -| *Getter* | get_db() | -+----------+---------------+ ++-----------+---------------+ +| *Default* | 0 | ++-----------+---------------+ +| *Setter* | set_db(value) | ++-----------+---------------+ +| *Getter* | get_db() | ++-----------+---------------+ .. _class_AudioEffectFilter_property_gain: - :ref:`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` **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. diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 85375eff2..35b976013 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -19,15 +19,15 @@ Adds a soft-clip limiter audio effect to an Audio bus. Properties ---------- -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ceiling_db` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`soft_clip_db` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`soft_clip_ratio` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`threshold_db` | -+---------------------------+---------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`ceiling_db` | -0.1 | ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`soft_clip_db` | 2.0 | ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`soft_clip_ratio` | 10.0 | ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`threshold_db` | 0.0 | ++---------------------------+---------------------------------------------------------------------------+------+ Description ----------- @@ -43,45 +43,53 @@ Property Descriptions - :ref:`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` **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` **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` **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. diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index fcf527698..187efa0ad 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -19,9 +19,9 @@ Adds a panner audio effect to an Audio bus. Pans sound left or right. Properties ---------- -+---------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`pan` | -+---------------------------+--------------------------------------------------+ ++---------------------------+--------------------------------------------------+-----+ +| :ref:`float` | :ref:`pan` | 0.0 | ++---------------------------+--------------------------------------------------+-----+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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). diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index d0ca0334e..0a2121652 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -21,17 +21,17 @@ Combines the original signal with a copy that is slightly out of phase with the Properties ---------- -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`depth` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`feedback` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`range_max_hz` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`range_min_hz` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`rate_hz` | -+---------------------------+--------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`depth` | 1.0 | ++---------------------------+--------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`feedback` | 0.7 | ++---------------------------+--------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`range_max_hz` | 1600.0 | ++---------------------------+--------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`range_min_hz` | 440.0 | ++---------------------------+--------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`rate_hz` | 0.5 | ++---------------------------+--------------------------------------------------------------------+--------+ Description ----------- @@ -45,59 +45,69 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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. diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 062225e20..e7d3679a6 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -21,13 +21,13 @@ Raises or lowers the pitch of original sound. Properties ---------- -+------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`FFT_Size` | :ref:`fft_size` | -+------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`oversampling` | -+------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+------------------------------------------------------+------------------------------------------------------------------------+ ++------------------------------------------------------+------------------------------------------------------------------------+-----+ +| :ref:`FFT_Size` | :ref:`fft_size` | 3 | ++------------------------------------------------------+------------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`oversampling` | 4 | ++------------------------------------------------------+------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`pitch_scale` | 1.0 | ++------------------------------------------------------+------------------------------------------------------------------------+-----+ Enumerations ------------ @@ -72,31 +72,37 @@ Property Descriptions - :ref:`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` **oversampling** -+----------+-------------------------+ -| *Setter* | set_oversampling(value) | -+----------+-------------------------+ -| *Getter* | get_oversampling() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 4 | ++-----------+-------------------------+ +| *Setter* | set_oversampling(value) | ++-----------+-------------------------+ +| *Getter* | get_oversampling() | ++-----------+-------------------------+ .. _class_AudioEffectPitchShift_property_pitch_scale: - :ref:`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). diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index b95c8dff3..d490762c9 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+----------------------------------------------+--------------------------------------------------------+ -| :ref:`Format` | :ref:`format` | -+----------------------------------------------+--------------------------------------------------------+ ++----------------------------------------------+--------------------------------------------------------+---+ +| :ref:`Format` | :ref:`format` | 1 | ++----------------------------------------------+--------------------------------------------------------+---+ Methods ------- @@ -41,11 +41,13 @@ Property Descriptions - :ref:`Format` **format** -+----------+-------------------+ -| *Setter* | set_format(value) | -+----------+-------------------+ -| *Getter* | get_format() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1 | ++-----------+-------------------+ +| *Setter* | set_format(value) | ++-----------+-------------------+ +| *Getter* | get_format() | ++-----------+-------------------+ Method Descriptions ------------------- diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index 12dd18758..fd5ad9ec7 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -21,23 +21,23 @@ Simulates the sound of acoustic environments such as rooms, concert halls, caver Properties ---------- -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dry` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hipass` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`predelay_feedback` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`predelay_msec` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`room_size` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spread` | -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`wet` | -+---------------------------+------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`damping` | 0.5 | ++---------------------------+------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`dry` | 1.0 | ++---------------------------+------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`hipass` | 0.0 | ++---------------------------+------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`predelay_feedback` | 0.4 | ++---------------------------+------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`predelay_msec` | 150.0 | ++---------------------------+------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`room_size` | 0.8 | ++---------------------------+------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`spread` | 1.0 | ++---------------------------+------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`wet` | 0.5 | ++---------------------------+------------------------------------------------------------------------------+-------+ Description ----------- @@ -51,95 +51,111 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **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` **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` **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. diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index e14ad9137..99a64c32b 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -19,13 +19,13 @@ Brief Description Properties ---------- -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`buffer_length` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`FFT_Size` | :ref:`fft_size` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap_back_pos` | -+------------------------------------------------------------+--------------------------------------------------------------------------------+ ++------------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`buffer_length` | 2.0 | ++------------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`FFT_Size` | :ref:`fft_size` | 2 | ++------------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`tap_back_pos` | 0.01 | ++------------------------------------------------------------+--------------------------------------------------------------------------------+------+ Enumerations ------------ @@ -65,29 +65,35 @@ Property Descriptions - :ref:`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` **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` **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() | ++-----------+-------------------------+ diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 5a55dc5b4..0d631ba31 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -19,13 +19,13 @@ Brief Description Properties ---------- -+---------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pan_pullout` | -+---------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`surround` | -+---------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`time_pullout_ms` | -+---------------------------+---------------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`pan_pullout` | 1.0 | ++---------------------------+---------------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`surround` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`time_pullout_ms` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------+-----+ Property Descriptions --------------------- @@ -34,29 +34,35 @@ Property Descriptions - :ref:`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` **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` **time_pullout_ms** -+----------+-------------------------+ -| *Setter* | set_time_pullout(value) | -+----------+-------------------------+ -| *Getter* | get_time_pullout() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------+ +| *Setter* | set_time_pullout(value) | ++-----------+-------------------------+ +| *Getter* | get_time_pullout() | ++-----------+-------------------------+ diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 424c9ef39..a9453883d 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -16,6 +16,17 @@ Brief Description Server interface for low-level audio access. +Properties +---------- + ++-----------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`bus_count` | 1 | ++-----------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`String` | :ref:`device` | "Default" | ++-----------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`global_rate_scale` | 1.0 | ++-----------------------------+------------------------------------------------------------------------+-----------+ + Methods ------- @@ -34,8 +45,6 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bus_channels` **(** :ref:`int` bus_idx **)** const | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_count` **(** **)** const | -+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | @@ -54,8 +63,6 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_device` **(** **)** | -+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_device_list` **(** **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_mix_rate` **(** **)** const | @@ -86,8 +93,6 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | -+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | @@ -102,8 +107,6 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`String` device **)** | -+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`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` **bus_count** + ++-----------+----------------------+ +| *Default* | 1 | ++-----------+----------------------+ +| *Setter* | set_bus_count(value) | ++-----------+----------------------+ +| *Getter* | get_bus_count() | ++-----------+----------------------+ + +Number of available audio buses. + +.. _class_AudioServer_property_device: + +- :ref:`String` **device** + ++-----------+-------------------+ +| *Default* | "Default" | ++-----------+-------------------+ +| *Setter* | set_device(value) | ++-----------+-------------------+ +| *Getter* | get_device() | ++-----------+-------------------+ + +Name of the current device (see :ref:`get_device_list`). + +.. _class_AudioServer_property_global_rate_scale: + +- :ref:`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` using the available bus Returns the amount of channels of the bus at index ``bus_idx``. -.. _class_AudioServer_method_get_bus_count: - -- :ref:`int` **get_bus_count** **(** **)** const - -Returns the number of available buses. - .. _class_AudioServer_method_get_bus_effect: - :ref:`AudioEffect` **get_bus_effect** **(** :ref:`int` bus_idx, :ref:`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` **get_device** **(** **)** - .. _class_AudioServer_method_get_device_list: - :ref:`Array` **get_device_list** **(** **)** +Returns the names of all audio devices detected on the system. + .. _class_AudioServer_method_get_mix_rate: - :ref:`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` **get_output_latency** **(** **)** const +Returns the audio driver's output latency. + .. _class_AudioServer_method_get_speaker_mode: - :ref:`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` 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` bus_idx, :ref:`int` effect_idx, :ref:`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` device **)** - .. _class_AudioServer_method_swap_bus_effects: - void **swap_bus_effects** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** diff --git a/classes/class_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst index d7f475d6e..ab6e19f04 100644 --- a/classes/class_audiostreamgenerator.rst +++ b/classes/class_audiostreamgenerator.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`float` | :ref:`buffer_length` | -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mix_rate` | -+---------------------------+-------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`buffer_length` | 0.5 | ++---------------------------+-------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`mix_rate` | 44100.0 | ++---------------------------+-------------------------------------------------------------------------+---------+ Property Descriptions --------------------- @@ -32,19 +32,23 @@ Property Descriptions - :ref:`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` **mix_rate** -+----------+---------------------+ -| *Setter* | set_mix_rate(value) | -+----------+---------------------+ -| *Getter* | get_mix_rate() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 44100.0 | ++-----------+---------------------+ +| *Setter* | set_mix_rate(value) | ++-----------+---------------------+ +| *Getter* | get_mix_rate() | ++-----------+---------------------+ diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 11a04e996..2eac79f32 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -19,13 +19,13 @@ OGG Vorbis audio stream driver. Properties ---------- -+-------------------------------------------+---------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`data` | -+-------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+-------------------------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`loop_offset` | -+-------------------------------------------+---------------------------------------------------------------------+ ++-------------------------------------------+---------------------------------------------------------------------+-------------------+ +| :ref:`PoolByteArray` | :ref:`data` | PoolByteArray( ) | ++-------------------------------------------+---------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`loop` | false | ++-------------------------------------------+---------------------------------------------------------------------+-------------------+ +| :ref:`float` | :ref:`loop_offset` | 0.0 | ++-------------------------------------------+---------------------------------------------------------------------+-------------------+ Description ----------- @@ -39,11 +39,13 @@ Property Descriptions - :ref:`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` **loop** -+----------+-----------------+ -| *Setter* | set_loop(value) | -+----------+-----------------+ -| *Getter* | has_loop() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_loop(value) | ++-----------+-----------------+ +| *Getter* | has_loop() | ++-----------+-----------------+ .. _class_AudioStreamOGGVorbis_property_loop_offset: - :ref:`float` **loop_offset** -+----------+------------------------+ -| *Setter* | set_loop_offset(value) | -+----------+------------------------+ -| *Getter* | get_loop_offset() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_loop_offset(value) | ++-----------+------------------------+ +| *Getter* | get_loop_offset() | ++-----------+------------------------+ diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index f3178a5ae..7a4182593 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -19,23 +19,23 @@ Plays back audio non-positionally. Properties ---------- -+----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`autoplay` | -+----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`String` | :ref:`bus` | -+----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`MixTarget` | :ref:`mix_target` | -+----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`stream` | -+----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stream_paused` | -+----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`volume_db` | -+----------------------------------------------------+----------------------------------------------------------------------+ ++----------------------------------------------------+----------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`autoplay` | false | ++----------------------------------------------------+----------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`bus` | "Master" | ++----------------------------------------------------+----------------------------------------------------------------------+----------+ +| :ref:`MixTarget` | :ref:`mix_target` | 0 | ++----------------------------------------------------+----------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`pitch_scale` | 1.0 | ++----------------------------------------------------+----------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`playing` | false | ++----------------------------------------------------+----------------------------------------------------------------------+----------+ +| :ref:`AudioStream` | :ref:`stream` | null | ++----------------------------------------------------+----------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`stream_paused` | false | ++----------------------------------------------------+----------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`volume_db` | 0.0 | ++----------------------------------------------------+----------------------------------------------------------------------+----------+ Methods ------- @@ -97,23 +97,27 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **stream** -+----------+-------------------+ -| *Setter* | set_stream(value) | -+----------+-------------------+ -| *Getter* | get_stream() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | null | ++-----------+-------------------+ +| *Setter* | set_stream(value) | ++-----------+-------------------+ +| *Getter* | get_stream() | ++-----------+-------------------+ The :ref:`AudioStream` object to be played. @@ -167,21 +179,25 @@ The :ref:`AudioStream` object to be played. - :ref:`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` **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. diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index c9a0aef7f..1afedfb0c 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -19,27 +19,27 @@ Plays audio in 2D. Properties ---------- -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_mask` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`attenuation` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`autoplay` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`bus` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max_distance` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`stream` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stream_paused` | -+---------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`volume_db` | -+---------------------------------------+------------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`area_mask` | 1 | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`attenuation` | 1.0 | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`autoplay` | false | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`bus` | "Master" | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`max_distance` | 2000.0 | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`pitch_scale` | 1.0 | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`playing` | false | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`AudioStream` | :ref:`stream` | null | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`stream_paused` | false | ++---------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`volume_db` | 0.0 | ++---------------------------------------+------------------------------------------------------------------------+----------+ Methods ------- @@ -82,11 +82,13 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **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` **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` **stream** -+----------+-------------------+ -| *Setter* | set_stream(value) | -+----------+-------------------+ -| *Getter* | get_stream() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | null | ++-----------+-------------------+ +| *Setter* | set_stream(value) | ++-----------+-------------------+ +| *Getter* | get_stream() | ++-----------+-------------------+ The :ref:`AudioStream` object to be played. @@ -176,21 +192,25 @@ The :ref:`AudioStream` object to be played. - :ref:`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` **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. diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 44473be8a..04ac84bfa 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -19,45 +19,45 @@ Plays 3D sound in 3D space. Properties ---------- -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_mask` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`attenuation_filter_cutoff_hz` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`attenuation_filter_db` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`AttenuationModel` | :ref:`attenuation_model` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`autoplay` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`bus` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`DopplerTracking` | :ref:`doppler_tracking` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_angle_degrees` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emission_angle_enabled` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_angle_filter_attenuation_db` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max_db` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max_distance` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`OutOfRangeMode` | :ref:`out_of_range_mode` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`stream` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stream_paused` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`unit_db` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`unit_size` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`area_mask` | 1 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`attenuation_filter_cutoff_hz` | 5000.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`attenuation_filter_db` | -24.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`AttenuationModel` | :ref:`attenuation_model` | 0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`autoplay` | false | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`bus` | "Master" | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`DopplerTracking` | :ref:`doppler_tracking` | 0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`emission_angle_degrees` | 45.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`emission_angle_enabled` | false | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`emission_angle_filter_attenuation_db` | -12.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`max_db` | 3.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`max_distance` | 0.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`OutOfRangeMode` | :ref:`out_of_range_mode` | 0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`pitch_scale` | 1.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`playing` | false | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`AudioStream` | :ref:`stream` | null | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`stream_paused` | false | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`unit_db` | 0.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`unit_size` | 1.0 | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+----------+ Methods ------- @@ -151,11 +151,13 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **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` **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` **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` **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` **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` and :ref:`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` **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` **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` takes effect. Has no effect if set to 0. @@ -295,11 +319,13 @@ Sets the distance from which the :ref:`out_of_range_mode` **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` range. @@ -307,11 +333,13 @@ Decides if audio should pause when source is outside of :ref:`max_distance` **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` **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` **stream** -+----------+-------------------+ -| *Setter* | set_stream(value) | -+----------+-------------------+ -| *Getter* | get_stream() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | null | ++-----------+-------------------+ +| *Setter* | set_stream(value) | ++-----------+-------------------+ +| *Getter* | get_stream() | ++-----------+-------------------+ The :ref:`AudioStream` object to be played. @@ -341,21 +373,25 @@ The :ref:`AudioStream` object to be played. - :ref:`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` **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` **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. diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 6a7ad791e..62da64f79 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -19,11 +19,11 @@ Plays audio with random pitch shifting. Properties ---------- -+---------------------------------------+-------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`audio_stream` | -+---------------------------------------+-------------------------------------------------------------------------+ -| :ref:`float` | :ref:`random_pitch` | -+---------------------------------------+-------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------+------+ +| :ref:`AudioStream` | :ref:`audio_stream` | null | ++---------------------------------------+-------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`random_pitch` | 1.1 | ++---------------------------------------+-------------------------------------------------------------------------+------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`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`. @@ -49,11 +51,13 @@ The current :ref:`AudioStream`. - :ref:`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. diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index bee1ac882..c1e5584cf 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -19,21 +19,21 @@ Stores audio data loaded from WAV files. Properties ---------- -+--------------------------------------------------+----------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`data` | -+--------------------------------------------------+----------------------------------------------------------------+ -| :ref:`Format` | :ref:`format` | -+--------------------------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`loop_begin` | -+--------------------------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`loop_end` | -+--------------------------------------------------+----------------------------------------------------------------+ -| :ref:`LoopMode` | :ref:`loop_mode` | -+--------------------------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`mix_rate` | -+--------------------------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`stereo` | -+--------------------------------------------------+----------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------+-------------------+ +| :ref:`PoolByteArray` | :ref:`data` | PoolByteArray( ) | ++--------------------------------------------------+----------------------------------------------------------------+-------------------+ +| :ref:`Format` | :ref:`format` | 0 | ++--------------------------------------------------+----------------------------------------------------------------+-------------------+ +| :ref:`int` | :ref:`loop_begin` | 0 | ++--------------------------------------------------+----------------------------------------------------------------+-------------------+ +| :ref:`int` | :ref:`loop_end` | 0 | ++--------------------------------------------------+----------------------------------------------------------------+-------------------+ +| :ref:`LoopMode` | :ref:`loop_mode` | 0 | ++--------------------------------------------------+----------------------------------------------------------------+-------------------+ +| :ref:`int` | :ref:`mix_rate` | 44100 | ++--------------------------------------------------+----------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`stereo` | false | ++--------------------------------------------------+----------------------------------------------------------------+-------------------+ Methods ------- @@ -95,11 +95,13 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **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` **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 ------------------- diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 54ce0ccf2..9fba7a483 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -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` | :ref:`copy_mode` | -+-----------------------------------------------+-----------------------------------------------------------+ -| :ref:`Rect2` | :ref:`rect` | -+-----------------------------------------------+-----------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------+-------------------------------+ +| :ref:`CopyMode` | :ref:`copy_mode` | 1 | ++-----------------------------------------------+-----------------------------------------------------------+-------------------------------+ +| :ref:`Rect2` | :ref:`rect` | Rect2( -100, -100, 200, 200 ) | ++-----------------------------------------------+-----------------------------------------------------------+-------------------------------+ Enumerations ------------ @@ -56,11 +56,13 @@ Property Descriptions - :ref:`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` constants. @@ -68,11 +70,13 @@ Buffer mode. See :ref:`CopyMode` constants. - :ref:`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` is :ref:`COPY_MODE_RECT`. diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index a7d11bd9f..47872e189 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -19,27 +19,27 @@ Prerendered indirect light map for a scene. Properties ---------- -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bake_cell_size` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bake_energy` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`bake_extents` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bake_hdr` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`BakeMode` | :ref:`bake_mode` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bake_propagation` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`BakeQuality` | :ref:`bake_quality` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`capture_cell_size` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`image_path` | -+----------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`BakedLightmapData` | :ref:`light_data` | -+----------------------------------------------------+--------------------------------------------------------------------------+ ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`bake_cell_size` | 0.25 | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`bake_energy` | 1.0 | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`bake_extents` | Vector3( 10, 10, 10 ) | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`bake_hdr` | false | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`BakeMode` | :ref:`bake_mode` | 0 | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`bake_propagation` | 1.0 | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`BakeQuality` | :ref:`bake_quality` | 1 | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`capture_cell_size` | 0.5 | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`String` | :ref:`image_path` | "." | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ +| :ref:`BakedLightmapData` | :ref:`light_data` | null | ++----------------------------------------------------+--------------------------------------------------------------------------+-----------------------+ Methods ------- @@ -122,33 +122,39 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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`. @@ -180,21 +190,25 @@ Lightmapping mode. See :ref:`BakeMode`. - :ref:`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` **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`. @@ -202,11 +216,13 @@ Three quality modes are available. Higher quality requires more rendering time. - :ref:`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`. @@ -214,11 +230,13 @@ Grid size used for real-time capture information on dynamic objects. Cannot be l - :ref:`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` **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. diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst index 70c8bdd66..6cc2aa4b1 100644 --- a/classes/class_bakedlightmapdata.rst +++ b/classes/class_bakedlightmapdata.rst @@ -19,17 +19,17 @@ Brief Description Properties ---------- -+-------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`bounds` | -+-------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`cell_space_transform` | -+-------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cell_subdiv` | -+-------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`energy` | -+-------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`octree` | -+-------------------------------------------+------------------------------------------------------------------------------------+ ++-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`AABB` | :ref:`bounds` | AABB( 0, 0, 0, 0, 0, 0 ) | ++-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`cell_space_transform` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`int` | :ref:`cell_subdiv` | 1 | ++-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`energy` | 1.0 | ++-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`octree` | PoolByteArray( ) | ++-------------------------------------------+------------------------------------------------------------------------------------+-------------------------------------------------+ Methods ------- @@ -53,51 +53,61 @@ Property Descriptions - :ref:`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` **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` **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` **energy** -+----------+-------------------+ -| *Setter* | set_energy(value) | -+----------+-------------------+ -| *Getter* | get_energy() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_energy(value) | ++-----------+-------------------+ +| *Getter* | get_energy() | ++-----------+-------------------+ .. _class_BakedLightmapData_property_octree: - :ref:`PoolByteArray` **octree** -+----------+-------------------+ -| *Setter* | set_octree(value) | -+----------+-------------------+ -| *Getter* | get_octree() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | PoolByteArray( ) | ++-----------+-------------------+ +| *Setter* | set_octree(value) | ++-----------+-------------------+ +| *Getter* | get_octree() | ++-----------+-------------------+ Method Descriptions ------------------- diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 78d7b26b3..42261ba97 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -21,27 +21,27 @@ Base class for different kinds of buttons. Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`ActionMode` | :ref:`action_mode` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`button_mask` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`enabled_focus_mode` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`ButtonGroup` | :ref:`group` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`keep_pressed_outside` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`shortcut` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shortcut_in_tooltip` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`toggle_mode` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`ActionMode` | :ref:`action_mode` | 1 | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`button_mask` | 1 | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`disabled` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`FocusMode` | :ref:`enabled_focus_mode` | 2 | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`ButtonGroup` | :ref:`group` | null | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`keep_pressed_outside` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`pressed` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`ShortCut` | :ref:`shortcut` | null | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`shortcut_in_tooltip` | true | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`toggle_mode` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+-------+ Methods ------- @@ -134,11 +134,13 @@ Property Descriptions - :ref:`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` **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` **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` **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` and :ref:`disabled`). @@ -184,11 +192,13 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont - :ref:`ButtonGroup` **group** -+----------+-------------------------+ -| *Setter* | set_button_group(value) | -+----------+-------------------------+ -| *Getter* | get_button_group() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | null | ++-----------+-------------------------+ +| *Setter* | set_button_group(value) | ++-----------+-------------------------+ +| *Getter* | get_button_group() | ++-----------+-------------------------+ :ref:`ButtonGroup` associated to the button. @@ -196,23 +206,27 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont - :ref:`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` **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` **shortcut** -+----------+---------------------+ -| *Setter* | set_shortcut(value) | -+----------+---------------------+ -| *Getter* | get_shortcut() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_shortcut(value) | ++-----------+---------------------+ +| *Getter* | get_shortcut() | ++-----------+---------------------+ :ref:`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` **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` **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. diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 3241180d6..8f1800dc4 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -17,13 +17,13 @@ Brief Description Properties ---------- -+-------------------------------+----------------------------------+ -| :ref:`Vector3` | :ref:`x` | -+-------------------------------+----------------------------------+ -| :ref:`Vector3` | :ref:`y` | -+-------------------------------+----------------------------------+ -| :ref:`Vector3` | :ref:`z` | -+-------------------------------+----------------------------------+ ++-------------------------------+----------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`x` | Vector3( 1, 0, 0 ) | ++-------------------------------+----------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`y` | Vector3( 0, 1, 0 ) | ++-------------------------------+----------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`z` | Vector3( 0, 0, 1 ) | ++-------------------------------+----------------------------------+--------------------+ Methods ------- @@ -91,18 +91,30 @@ Property Descriptions - :ref:`Vector3` **x** ++-----------+--------------------+ +| *Default* | Vector3( 1, 0, 0 ) | ++-----------+--------------------+ + The basis matrix's X vector. .. _class_Basis_property_y: - :ref:`Vector3` **y** ++-----------+--------------------+ +| *Default* | Vector3( 0, 1, 0 ) | ++-----------+--------------------+ + The basis matrix's Y vector. .. _class_Basis_property_z: - :ref:`Vector3` **z** ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 1 ) | ++-----------+--------------------+ + The basis matrix's Z vector. Method Descriptions diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 5ec58c708..f9ed9a9ab 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -19,15 +19,15 @@ Renders text using ``*.fnt`` fonts. Properties ---------- -+-------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`ascent` | -+-------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`distance_field` | -+-------------------------------------+-----------------------------------------------------------------+ -| :ref:`BitmapFont` | :ref:`fallback` | -+-------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+-------------------------------------+-----------------------------------------------------------------+ ++-------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`ascent` | 0.0 | ++-------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`distance_field` | false | ++-------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`BitmapFont` | :ref:`fallback` | null | ++-------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`height` | 1.0 | ++-------------------------------------+-----------------------------------------------------------------+-------+ Methods ------- @@ -64,11 +64,13 @@ Property Descriptions - :ref:`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` **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` **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` **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. diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index c208be6d4..dc5120a80 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -19,11 +19,11 @@ Joint used with :ref:`Skeleton2D` to control and animate other Properties ---------- -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`default_length` | -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`rest` | -+---------------------------------------+-------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------+---------------------------------+ +| :ref:`float` | :ref:`default_length` | 16.0 | ++---------------------------------------+-------------------------------------------------------------+---------------------------------+ +| :ref:`Transform2D` | :ref:`rest` | Transform2D( 0, 0, 0, 0, 0, 0 ) | ++---------------------------------------+-------------------------------------------------------------+---------------------------------+ Methods ------- @@ -54,11 +54,13 @@ Property Descriptions - :ref:`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` **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`. diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index 89ee72dfc..d01fdb712 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -19,9 +19,9 @@ A node that will attach to a bone. Properties ---------- -+-----------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`bone_name` | -+-----------------------------+-----------------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------+----+ +| :ref:`String` | :ref:`bone_name` | "" | ++-----------------------------+-----------------------------------------------------------+----+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 44655200e..5e6c789dd 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -21,9 +21,9 @@ Base class for box containers. Properties ---------- -+-----------------------------------------------+---------------------------------------------------------+ -| :ref:`AlignMode` | :ref:`alignment` | -+-----------------------------------------------+---------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------+---+ +| :ref:`AlignMode` | :ref:`alignment` | 0 | ++-----------------------------------------------+---------------------------------------------------------+---+ Methods ------- @@ -63,11 +63,13 @@ Property Descriptions - :ref:`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`, :ref:`ALIGN_CENTER` or :ref:`ALIGN_END`). diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index 15f89eb4d..662505fe4 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -19,9 +19,9 @@ Box shape resource. Properties ---------- -+-------------------------------+-------------------------------------------------+ -| :ref:`Vector3` | :ref:`extents` | -+-------------------------------+-------------------------------------------------+ ++-------------------------------+-------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`extents` | Vector3( 1, 1, 1 ) | ++-------------------------------+-------------------------------------------------+--------------------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_button.rst b/classes/class_button.rst index de6cc6381..614e826b0 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -21,44 +21,44 @@ Standard themed Button. Properties ---------- -+-----------------------------------------+---------------------------------------------------+ -| :ref:`TextAlign` | :ref:`align` | -+-----------------------------------------+---------------------------------------------------+ -| :ref:`bool` | :ref:`clip_text` | -+-----------------------------------------+---------------------------------------------------+ -| :ref:`bool` | :ref:`flat` | -+-----------------------------------------+---------------------------------------------------+ -| :ref:`Texture` | :ref:`icon` | -+-----------------------------------------+---------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+-----------------------------------------+---------------------------------------------------+ ++-----------------------------------------+---------------------------------------------------+-------+ +| :ref:`TextAlign` | :ref:`align` | 1 | ++-----------------------------------------+---------------------------------------------------+-------+ +| :ref:`bool` | :ref:`clip_text` | false | ++-----------------------------------------+---------------------------------------------------+-------+ +| :ref:`bool` | :ref:`flat` | false | ++-----------------------------------------+---------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`icon` | null | ++-----------------------------------------+---------------------------------------------------+-------+ +| :ref:`String` | :ref:`text` | "" | ++-----------------------------------------+---------------------------------------------------+-------+ Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`StyleBox` | disabled | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+---------------------+ -| :ref:`Font` | font | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_pressed | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | hover | -+---------------------------------+---------------------+ -| :ref:`int` | hseparation | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | pressed | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | disabled | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | hover | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | hseparation | 2 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | pressed | | ++---------------------------------+---------------------+------------------------------------------+ Enumerations ------------ @@ -91,11 +91,13 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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. diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 81c555bac..682ad1f3a 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -21,33 +21,33 @@ Camera node, displays from a point of view. Properties ---------- -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`cull_mask` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`current` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`DopplerTracking` | :ref:`doppler_tracking` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Environment` | :ref:`environment` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`far` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`fov` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`frustum_offset` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`h_offset` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`KeepAspect` | :ref:`keep_aspect` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`near` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Projection` | :ref:`projection` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`size` | -+-----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`v_offset` | -+-----------------------------------------------------+-----------------------------------------------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`cull_mask` | 1048575 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`current` | false | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`DopplerTracking` | :ref:`doppler_tracking` | 0 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`Environment` | :ref:`environment` | null | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`far` | 100.0 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`fov` | 70.0 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`frustum_offset` | Vector2( 0, 0 ) | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`h_offset` | 0.0 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`KeepAspect` | :ref:`keep_aspect` | 1 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`near` | 0.05 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`Projection` | :ref:`projection` | 0 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`size` | 1.0 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`v_offset` | 0.0 | ++-----------------------------------------------------+-----------------------------------------------------------------+-----------------+ Methods ------- @@ -145,11 +145,13 @@ Property Descriptions - :ref:`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` **current** -+----------+--------------------+ -| *Setter* | set_current(value) | -+----------+--------------------+ -| *Getter* | is_current() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_current(value) | ++-----------+--------------------+ +| *Getter* | is_current() | ++-----------+--------------------+ -If ``true``, the ancestor :ref:`Viewport` is currently using this camera. Default value: ``false``. +If ``true``, the ancestor :ref:`Viewport` is currently using this camera. .. _class_Camera_property_doppler_tracking: - :ref:`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`, this camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. See :ref:`DopplerTracking` for possible values. Default value: :ref:`DOPPLER_TRACKING_DISABLED`. +If not :ref:`DOPPLER_TRACKING_DISABLED`, this camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. See :ref:`DopplerTracking` for possible values. .. _class_Camera_property_environment: - :ref:`Environment` **environment** -+----------+------------------------+ -| *Setter* | set_environment(value) | -+----------+------------------------+ -| *Getter* | get_environment() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_environment(value) | ++-----------+------------------------+ +| *Getter* | get_environment() | ++-----------+------------------------+ The :ref:`Environment` to use for this camera. @@ -193,11 +201,13 @@ The :ref:`Environment` to use for this camera. - :ref:`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` **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` 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` **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` **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` **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`/:ref:`size` adjustments. Can be either :ref:`KEEP_WIDTH` or :ref:`KEEP_HEIGHT`. @@ -251,11 +269,13 @@ The axis to lock during :ref:`fov`/:ref:`size` **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` **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` 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` **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` 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` **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. diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 01743ae38..2b5907d7b 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -19,57 +19,57 @@ Camera node for 2D scenes. Properties ---------- -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`AnchorMode` | :ref:`anchor_mode` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`current` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`custom_viewport` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_margin_bottom` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`drag_margin_h_enabled` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_margin_left` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_margin_right` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_margin_top` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`drag_margin_v_enabled` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_draw_drag_margin` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_draw_limits` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_draw_screen` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`limit_bottom` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`limit_left` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`limit_right` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`limit_smoothed` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`limit_top` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`offset_h` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`offset_v` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Camera2DProcessMode` | :ref:`process_mode` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rotating` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`smoothing_enabled` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`smoothing_speed` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`zoom` | -+---------------------------------------------------------------+---------------------------------------------------------------------------------+ ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`AnchorMode` | :ref:`anchor_mode` | 1 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`current` | false | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`Node` | :ref:`custom_viewport` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`drag_margin_bottom` | 0.2 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`drag_margin_h_enabled` | true | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`drag_margin_left` | 0.2 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`drag_margin_right` | 0.2 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`drag_margin_top` | 0.2 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`drag_margin_v_enabled` | true | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`editor_draw_drag_margin` | false | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`editor_draw_limits` | false | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`editor_draw_screen` | true | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`limit_bottom` | 10000000 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`limit_left` | -10000000 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`limit_right` | 10000000 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`limit_smoothed` | false | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`limit_top` | -10000000 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`offset_h` | 0.0 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`offset_v` | 0.0 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`Camera2DProcessMode` | :ref:`process_mode` | 1 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`rotating` | false | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`smoothing_enabled` | false | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`smoothing_speed` | 5.0 | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`zoom` | Vector2( 1, 1 ) | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+-----------------+ Methods ------- @@ -131,11 +131,13 @@ Property Descriptions - :ref:`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` **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` node attached to the ``Camera2D``. If - :ref:`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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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`. Default value: ``false``. +If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed`. .. _class_Camera2D_property_smoothing_speed: - :ref:`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` is ``true``. @@ -415,11 +461,13 @@ Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing - :ref:`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. diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index f6d80107e..f04e8cfc6 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -19,11 +19,11 @@ A camera feed gives you access to a single physical camera attached to your devi Properties ---------- -+---------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`feed_is_active` | -+---------------------------------------+-----------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`feed_transform` | -+---------------------------------------+-----------------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------+----------------------------------+ +| :ref:`bool` | :ref:`feed_is_active` | false | ++---------------------------------------+-----------------------------------------------------------------+----------------------------------+ +| :ref:`Transform2D` | :ref:`feed_transform` | Transform2D( 1, 0, 0, -1, 0, 1 ) | ++---------------------------------------+-----------------------------------------------------------------+----------------------------------+ Methods ------- @@ -89,21 +89,25 @@ Property Descriptions - :ref:`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` **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 ------------------- diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 716b8b45c..2e022be18 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -21,13 +21,13 @@ This texture gives access to the camera texture provided by a :ref:`CameraFeed` | :ref:`camera_feed_id` | -+-----------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`camera_is_active` | -+-----------------------------------------------+------------------------------------------------------------------------+ -| :ref:`FeedImage` | :ref:`which_feed` | -+-----------------------------------------------+------------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`camera_feed_id` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`camera_is_active` | false | ++-----------------------------------------------+------------------------------------------------------------------------+-------+ +| :ref:`FeedImage` | :ref:`which_feed` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------+-------+ Property Descriptions --------------------- @@ -36,11 +36,13 @@ Property Descriptions - :ref:`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` for which we want to display the image. @@ -48,11 +50,13 @@ The ID of the :ref:`CameraFeed` for which we want to display t - :ref:`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`. @@ -60,11 +64,13 @@ Convenience property that gives access to the active property of the :ref:`Camer - :ref:`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` we want access to, important if the camera image is split in a Y and CbCr component. diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 060b99af2..c1b6daf17 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -21,23 +21,23 @@ Base class of anything 2D. Properties ---------- -+---------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`light_mask` | -+---------------------------------+---------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+---------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`modulate` | -+---------------------------------+---------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`self_modulate` | -+---------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_behind_parent` | -+---------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_on_top` | -+---------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_parent_material` | -+---------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`visible` | -+---------------------------------+---------------------------------------------------------------------------+ ++---------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`light_mask` | 1 | ++---------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`Material` | :ref:`material` | null | ++---------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`modulate` | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`self_modulate` | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`show_behind_parent` | false | ++---------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`show_on_top` | | ++---------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`use_parent_material` | false | ++---------------------------------+---------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`visible` | true | ++---------------------------------+---------------------------------------------------------------------------+---------------------+ Methods ------- @@ -242,91 +242,105 @@ Property Descriptions - :ref:`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` nodes. Default value: ``1``. +The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. .. _class_CanvasItem_property_material: - :ref:`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` **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` **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` **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` **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` **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` property is used as this one's material. Default value: ``false``. +If ``true``, the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. .. _class_CanvasItem_property_visible: - :ref:`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`, 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`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead. Method Descriptions ------------------- diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 535269ca1..e7748939f 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -19,19 +19,19 @@ A material for :ref:`CanvasItem`\ s. Properties ---------- -+-----------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`BlendMode` | :ref:`blend_mode` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`LightMode` | :ref:`light_mode` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_anim_h_frames` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_anim_loop` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_anim_v_frames` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_animation` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`BlendMode` | :ref:`blend_mode` | 0 | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`LightMode` | :ref:`light_mode` | 0 | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`particles_anim_h_frames` | | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`particles_anim_loop` | | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`particles_anim_v_frames` | | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`particles_animation` | false | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+-------+ Enumerations ------------ @@ -88,11 +88,13 @@ Property Descriptions - :ref:`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` **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` **particles_animation** -+----------+--------------------------------+ -| *Setter* | set_particles_animation(value) | -+----------+--------------------------------+ -| *Getter* | get_particles_animation() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | false | ++-----------+--------------------------------+ +| *Setter* | set_particles_animation(value) | ++-----------+--------------------------------+ +| *Getter* | get_particles_animation() | ++-----------+--------------------------------+ diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index dfe93b4b1..138d83bb2 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -21,25 +21,25 @@ Canvas drawing layer. Properties ---------- -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`custom_viewport` | -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_viewport_enable` | -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`follow_viewport_scale` | -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`layer` | -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation` | -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation_degrees` | -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scale` | -+---------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+----------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Node` | :ref:`custom_viewport` | | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`bool` | :ref:`follow_viewport_enable` | false | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`float` | :ref:`follow_viewport_scale` | 1.0 | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`int` | :ref:`layer` | 1 | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`float` | :ref:`rotation` | 0.0 | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`float` | :ref:`rotation_degrees` | 0.0 | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Vector2` | :ref:`scale` | Vector2( 1, 1 ) | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | Transform2D( 1, 0, 0, 1, 0, 0 ) | ++---------------------------------------+----------------------------------------------------------------------------------+---------------------------------+ Methods ------- @@ -79,43 +79,51 @@ The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. - :ref:`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` **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` **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` **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` **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` **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` **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` **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. diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index 55fd85e2e..bf3adabf6 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -19,9 +19,9 @@ Tint the entire canvas. Properties ---------- -+---------------------------+---------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+---------------------------------------------------+ ++---------------------------+---------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`color` | Color( 1, 1, 1, 1 ) | ++---------------------------+---------------------------------------------------+---------------------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index f903f87c1..1c6217c0b 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -19,15 +19,15 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh`. Properties ---------- -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`mid_height` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`radial_segments` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`rings` | -+---------------------------+--------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`mid_height` | 1.0 | ++---------------------------+--------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`radial_segments` | 64 | ++---------------------------+--------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`radius` | 1.0 | ++---------------------------+--------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`rings` | 8 | ++---------------------------+--------------------------------------------------------------------+-----+ Description ----------- @@ -41,47 +41,55 @@ Property Descriptions - :ref:`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` **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` **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` **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. diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index a20efe40d..2af0d71ea 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -19,11 +19,11 @@ Capsule shape for collisions. Properties ---------- -+---------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+---------------------------------------------------+ ++---------------------------+---------------------------------------------------+-----+ +| :ref:`float` | :ref:`height` | 1.0 | ++---------------------------+---------------------------------------------------+-----+ +| :ref:`float` | :ref:`radius` | 1.0 | ++---------------------------+---------------------------------------------------+-----+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`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` **radius** -+----------+-------------------+ -| *Setter* | set_radius(value) | -+----------+-------------------+ -| *Getter* | get_radius() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ The capsule's radius. diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 6fccaf789..6cac2795b 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -19,11 +19,11 @@ Capsule shape for 2D collisions. Properties ---------- -+---------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+-----------------------------------------------------+ ++---------------------------+-----------------------------------------------------+------+ +| :ref:`float` | :ref:`height` | 20.0 | ++---------------------------+-----------------------------------------------------+------+ +| :ref:`float` | :ref:`radius` | 10.0 | ++---------------------------+-----------------------------------------------------+------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`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` **radius** -+----------+-------------------+ -| *Setter* | set_radius(value) | -+----------+-------------------+ -| *Getter* | get_radius() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 10.0 | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ The capsule's radius. diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 0f5f55bff..52988ef08 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -19,9 +19,9 @@ Keeps children controls centered. Properties ---------- -+-------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_top_left` | -+-------------------------+------------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`use_top_left` | false | ++-------------------------+------------------------------------------------------------------+-------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 252416ca0..fb1f81995 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -19,43 +19,43 @@ Binary choice user interface widget. Theme Properties ---------------- -+---------------------------------+--------------------------+ -| :ref:`int` | check_vadjust | -+---------------------------------+--------------------------+ -| :ref:`Texture` | checked | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | disabled | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+--------------------------+ -| :ref:`Font` | font | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color_hover_pressed | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color_pressed | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | hover | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | hover_pressed | -+---------------------------------+--------------------------+ -| :ref:`int` | hseparation | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | pressed | -+---------------------------------+--------------------------+ -| :ref:`Texture` | radio_checked | -+---------------------------------+--------------------------+ -| :ref:`Texture` | radio_unchecked | -+---------------------------------+--------------------------+ -| :ref:`Texture` | unchecked | -+---------------------------------+--------------------------+ ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`int` | check_vadjust | 0 | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Texture` | checked | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | disabled | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | hover | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | hover_pressed | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`int` | hseparation | 4 | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | pressed | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Texture` | radio_checked | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Texture` | radio_unchecked | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Texture` | unchecked | | ++---------------------------------+--------------------------+------------------------------------------+ Description ----------- diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index 9979e302c..06c05747c 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -19,43 +19,43 @@ Checkable button. Theme Properties ---------------- -+---------------------------------+--------------------------+ -| :ref:`int` | check_vadjust | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | disabled | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+--------------------------+ -| :ref:`Font` | font | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color_hover_pressed | -+---------------------------------+--------------------------+ -| :ref:`Color` | font_color_pressed | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | hover | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | hover_pressed | -+---------------------------------+--------------------------+ -| :ref:`int` | hseparation | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+--------------------------+ -| :ref:`Texture` | off | -+---------------------------------+--------------------------+ -| :ref:`Texture` | off_disabled | -+---------------------------------+--------------------------+ -| :ref:`Texture` | on | -+---------------------------------+--------------------------+ -| :ref:`Texture` | on_disabled | -+---------------------------------+--------------------------+ -| :ref:`StyleBox` | pressed | -+---------------------------------+--------------------------+ ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`int` | check_vadjust | 0 | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | disabled | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | hover | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | hover_pressed | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`int` | hseparation | 4 | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Texture` | off | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Texture` | off_disabled | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Texture` | on | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`Texture` | on_disabled | | ++---------------------------------+--------------------------+------------------------------------------+ +| :ref:`StyleBox` | pressed | | ++---------------------------------+--------------------------+------------------------------------------+ Description ----------- diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 368e47d17..d8b5d38a1 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -19,9 +19,9 @@ Circular shape for 2D collisions. Properties ---------- -+---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+----------------------------------------------------+ ++---------------------------+----------------------------------------------------+------+ +| :ref:`float` | :ref:`radius` | 10.0 | ++---------------------------+----------------------------------------------------+------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`float` **radius** -+----------+-------------------+ -| *Setter* | set_radius(value) | -+----------+-------------------+ -| *Getter* | get_radius() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 10.0 | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ The circle's radius. diff --git a/classes/class_clippedcamera.rst b/classes/class_clippedcamera.rst index 462530e4a..738d7074c 100644 --- a/classes/class_clippedcamera.rst +++ b/classes/class_clippedcamera.rst @@ -19,17 +19,17 @@ Brief Description Properties ---------- -+----------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`clip_to_areas` | -+----------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`clip_to_bodies` | -+----------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+----------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+----------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`ProcessMode` | :ref:`process_mode` | -+----------------------------------------------------+--------------------------------------------------------------------+ ++----------------------------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`clip_to_areas` | false | ++----------------------------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`clip_to_bodies` | true | ++----------------------------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++----------------------------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`margin` | 0.0 | ++----------------------------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`ProcessMode` | :ref:`process_mode` | 0 | ++----------------------------------------------------+--------------------------------------------------------------------+-------+ Methods ------- @@ -74,51 +74,61 @@ Property Descriptions - :ref:`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` **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` **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` **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` **process_mode** -+----------+-------------------------+ -| *Setter* | set_process_mode(value) | -+----------+-------------------------+ -| *Getter* | get_process_mode() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_process_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_process_mode() | ++-----------+-------------------------+ Method Descriptions ------------------- diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 62b2f2cd9..cdc00cdf9 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -21,11 +21,11 @@ Base node for collision objects. Properties ---------- -+-------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_capture_on_drag` | -+-------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_ray_pickable` | -+-------------------------+------------------------------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`input_capture_on_drag` | false | ++-------------------------+------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`input_ray_pickable` | true | ++-------------------------+------------------------------------------------------------------------------------+-------+ Methods ------- @@ -99,25 +99,29 @@ Property Descriptions - :ref:`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` **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`\ s. Default value: ``true``. +If ``true``, the ``CollisionObject``'s shapes will respond to :ref:`RayCast`\ s. Method Descriptions ------------------- diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 1e5a08017..cc7e20df5 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -21,9 +21,9 @@ Base node for 2D collision objects. Properties ---------- -+-------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_pickable` | -+-------------------------+------------------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`input_pickable` | true | ++-------------------------+------------------------------------------------------------------------+------+ Methods ------- @@ -105,11 +105,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 02170c461..a02eda51f 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -19,13 +19,13 @@ Editor-only class for defining a collision polygon in 3D space. Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`depth` | -+-------------------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-------------------------------------------------+-----------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+-------------------------------------------------+-----------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------+----------------------+ +| :ref:`float` | :ref:`depth` | 1.0 | ++-------------------------------------------------+-----------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`disabled` | false | ++-------------------------------------------------+-----------------------------------------------------------+----------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | PoolVector2Array( ) | ++-------------------------------------------------+-----------------------------------------------------------+----------------------+ Description ----------- @@ -39,11 +39,13 @@ Property Descriptions - :ref:`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` **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` **polygon** -+----------+--------------------+ -| *Setter* | set_polygon(value) | -+----------+--------------------+ -| *Getter* | get_polygon() | -+----------+--------------------+ ++-----------+----------------------+ +| *Default* | PoolVector2Array( ) | ++-----------+----------------------+ +| *Setter* | set_polygon(value) | ++-----------+----------------------+ +| *Getter* | get_polygon() | ++-----------+----------------------+ Array of vertices which define the polygon. diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 9c46ca840..f748c8971 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -19,17 +19,17 @@ Defines a 2D collision polygon. Properties ---------- -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`BuildMode` | :ref:`build_mode` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_way_collision` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`one_way_collision_margin` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`BuildMode` | :ref:`build_mode` | 0 | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`disabled` | false | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`one_way_collision` | false | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`float` | :ref:`one_way_collision_margin` | 1.0 | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | PoolVector2Array( ) | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------+ Enumerations ------------ @@ -58,23 +58,27 @@ Property Descriptions - :ref:`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`. +Collision build mode. Use one of the ``BUILD_*`` constants. .. _class_CollisionPolygon2D_property_disabled: - :ref:`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` **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` **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` **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. diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 87da83bb6..7cb3b1a71 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -19,11 +19,11 @@ Node that represents collision shape data in 3D space. Properties ---------- -+---------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+---------------------------+---------------------------------------------------------+ -| :ref:`Shape` | :ref:`shape` | -+---------------------------+---------------------------------------------------------+ ++---------------------------+---------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`disabled` | false | ++---------------------------+---------------------------------------------------------+-------+ +| :ref:`Shape` | :ref:`shape` | null | ++---------------------------+---------------------------------------------------------+-------+ Methods ------- @@ -51,11 +51,13 @@ Property Descriptions - :ref:`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` **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. diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 65926aebf..5f4a800d5 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -19,15 +19,15 @@ Node that represents collision shape data in 2D space. Properties ---------- -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_way_collision` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`one_way_collision_margin` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`shape` | -+-------------------------------+-------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`disabled` | false | ++-------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`one_way_collision` | false | ++-------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`one_way_collision_margin` | 1.0 | ++-------------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`Shape2D` | :ref:`shape` | null | ++-------------------------------+-------------------------------------------------------------------------------------------+-------+ Description ----------- @@ -46,11 +46,13 @@ Property Descriptions - :ref:`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` **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` **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` **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. diff --git a/classes/class_color.rst b/classes/class_color.rst index bd2b5b627..d45029c61 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -17,29 +17,29 @@ Color in RGBA format with some support for ARGB format. Properties ---------- -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`a` | -+---------------------------+------------------------------------+ -| :ref:`int` | :ref:`a8` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`b` | -+---------------------------+------------------------------------+ -| :ref:`int` | :ref:`b8` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`g` | -+---------------------------+------------------------------------+ -| :ref:`int` | :ref:`g8` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`h` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`r` | -+---------------------------+------------------------------------+ -| :ref:`int` | :ref:`r8` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`s` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`v` | -+---------------------------+------------------------------------+ ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`a` | 1.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`int` | :ref:`a8` | 255 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`b` | 0.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`int` | :ref:`b8` | 0 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`g` | 0.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`int` | :ref:`g8` | 0 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`h` | 0.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`r` | 0.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`int` | :ref:`r8` | 0 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`s` | 0.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`v` | 0.0 | ++---------------------------+------------------------------------+-----+ Methods ------- @@ -685,66 +685,110 @@ Property Descriptions - :ref:`float` **a** ++-----------+-----+ +| *Default* | 1.0 | ++-----------+-----+ + Alpha value (range 0 to 1). .. _class_Color_property_a8: - :ref:`int` **a8** ++-----------+-----+ +| *Default* | 255 | ++-----------+-----+ + Alpha value (range 0 to 255). .. _class_Color_property_b: - :ref:`float` **b** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + Blue value (range 0 to 1). .. _class_Color_property_b8: - :ref:`int` **b8** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + Blue value (range 0 to 255). .. _class_Color_property_g: - :ref:`float` **g** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + Green value (range 0 to 1). .. _class_Color_property_g8: - :ref:`int` **g8** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + Green value (range 0 to 255). .. _class_Color_property_h: - :ref:`float` **h** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + HSV hue value (range 0 to 1). .. _class_Color_property_r: - :ref:`float` **r** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + Red value (range 0 to 1). .. _class_Color_property_r8: - :ref:`int` **r8** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + Red value (range 0 to 255). .. _class_Color_property_s: - :ref:`float` **s** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + HSV saturation value (range 0 to 1). .. _class_Color_property_v: - :ref:`float` **v** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + HSV value (range 0 to 1). Method Descriptions diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 46248376b..fd33af280 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -19,21 +19,21 @@ Color picker control. Properties ---------- -+---------------------------+--------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`deferred_mode` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`edit_alpha` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hsv_mode` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`presets_enabled` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`presets_visible` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`raw_mode` | -+---------------------------+--------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`color` | Color( 1, 1, 1, 1 ) | ++---------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`deferred_mode` | false | ++---------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`edit_alpha` | true | ++---------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`hsv_mode` | false | ++---------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`presets_enabled` | true | ++---------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`presets_visible` | true | ++---------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`raw_mode` | false | ++---------------------------+--------------------------------------------------------------------+---------------------+ Methods ------- @@ -49,27 +49,27 @@ Methods Theme Properties ---------------- -+-------------------------------+---------------+ -| :ref:`Texture` | add_preset | -+-------------------------------+---------------+ -| :ref:`Texture` | color_hue | -+-------------------------------+---------------+ -| :ref:`Texture` | color_sample | -+-------------------------------+---------------+ -| :ref:`int` | h_width | -+-------------------------------+---------------+ -| :ref:`int` | label_width | -+-------------------------------+---------------+ -| :ref:`int` | margin | -+-------------------------------+---------------+ -| :ref:`Texture` | preset_bg | -+-------------------------------+---------------+ -| :ref:`Texture` | screen_picker | -+-------------------------------+---------------+ -| :ref:`int` | sv_height | -+-------------------------------+---------------+ -| :ref:`int` | sv_width | -+-------------------------------+---------------+ ++-------------------------------+---------------+-----+ +| :ref:`Texture` | add_preset | | ++-------------------------------+---------------+-----+ +| :ref:`Texture` | color_hue | | ++-------------------------------+---------------+-----+ +| :ref:`Texture` | color_sample | | ++-------------------------------+---------------+-----+ +| :ref:`int` | h_width | 30 | ++-------------------------------+---------------+-----+ +| :ref:`int` | label_width | 10 | ++-------------------------------+---------------+-----+ +| :ref:`int` | margin | 4 | ++-------------------------------+---------------+-----+ +| :ref:`Texture` | preset_bg | | ++-------------------------------+---------------+-----+ +| :ref:`Texture` | screen_picker | | ++-------------------------------+---------------+-----+ +| :ref:`int` | sv_height | 256 | ++-------------------------------+---------------+-----+ +| :ref:`int` | sv_width | 256 | ++-------------------------------+---------------+-----+ Signals ------- @@ -104,11 +104,13 @@ Property Descriptions - :ref:`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` **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` **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` **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` **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` **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` **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). diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 8dfcdc2a2..27c2a7288 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -19,11 +19,11 @@ Button that pops out a :ref:`ColorPicker`. Properties ---------- -+---------------------------+----------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`edit_alpha` | -+---------------------------+----------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`color` | Color( 0, 0, 0, 1 ) | ++---------------------------+----------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`edit_alpha` | true | ++---------------------------+----------------------------------------------------------------+---------------------+ Methods ------- @@ -37,31 +37,31 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`Texture` | bg | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | disabled | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+---------------------+ -| :ref:`Font` | font | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_pressed | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | hover | -+---------------------------------+---------------------+ -| :ref:`int` | hseparation | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | pressed | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+-----------------------------+ +| :ref:`Texture` | bg | | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | disabled | | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`Font` | font | | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`Color` | font_color | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.3 ) | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`Color` | font_color_hover | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`Color` | font_color_pressed | Color( 0.8, 0.8, 0.8, 1 ) | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | hover | | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`int` | hseparation | 2 | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | pressed | | ++---------------------------------+---------------------+-----------------------------+ Signals ------- @@ -88,11 +88,13 @@ Property Descriptions - :ref:`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` **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` will be visible. Default value: ``true``. +If ``true``, the alpha channel in the displayed :ref:`ColorPicker` will be visible. Method Descriptions ------------------- diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index a67d374d9..63fef82d2 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -19,9 +19,9 @@ Colored rectangle. Properties ---------- -+---------------------------+----------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+----------------------------------------------+ ++---------------------------+----------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`color` | Color( 1, 1, 1, 1 ) | ++---------------------------+----------------------------------------------+---------------------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 7e345105b..271333fd0 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -19,9 +19,9 @@ Concave polygon 2D shape resource for physics. Properties ---------- -+-------------------------------------------------+----------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`segments` | -+-------------------------------------------------+----------------------------------------------------------------+ ++-------------------------------------------------+----------------------------------------------------------------+----------------------+ +| :ref:`PoolVector2Array` | :ref:`segments` | PoolVector2Array( ) | ++-------------------------------------------------+----------------------------------------------------------------+----------------------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index 616b6cb59..d8d66a5a6 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -19,17 +19,17 @@ A twist joint between two 3D bodies. Properties ---------- -+---------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`bias` | -+---------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`relaxation` | -+---------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`softness` | -+---------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`swing_span` | -+---------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`twist_span` | -+---------------------------+-------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`bias` | 0.3 | ++---------------------------+-------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`relaxation` | 1.0 | ++---------------------------+-------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`softness` | 0.8 | ++---------------------------+-------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`swing_span` | 45.0 | ++---------------------------+-------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`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` **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` **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` **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` **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` **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. diff --git a/classes/class_control.rst b/classes/class_control.rst index 88011314e..a13d9e9b7 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -21,71 +21,71 @@ All User Interface nodes inherit from Control. A control's anchors and margins a Properties ---------- -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anchor_bottom` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anchor_left` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anchor_right` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anchor_top` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`focus_mode` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_neighbour_bottom` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_neighbour_left` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_neighbour_right` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_neighbour_top` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_next` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_previous` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`GrowDirection` | :ref:`grow_horizontal` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`GrowDirection` | :ref:`grow_vertical` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`hint_tooltip` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_bottom` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_left` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_right` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_top` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`MouseFilter` | :ref:`mouse_filter` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rect_clip_content` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_global_position` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_min_size` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_pivot_offset` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_position` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rect_rotation` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_scale` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_size` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size_flags_horizontal` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`size_flags_stretch_ratio` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size_flags_vertical` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Theme` | :ref:`theme` | -+--------------------------------------------------+--------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`anchor_bottom` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`anchor_left` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`anchor_right` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`anchor_top` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`FocusMode` | :ref:`focus_mode` | 0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`NodePath` | :ref:`focus_neighbour_bottom` | NodePath("") | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`NodePath` | :ref:`focus_neighbour_left` | NodePath("") | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`NodePath` | :ref:`focus_neighbour_right` | NodePath("") | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`NodePath` | :ref:`focus_neighbour_top` | NodePath("") | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`NodePath` | :ref:`focus_next` | NodePath("") | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`NodePath` | :ref:`focus_previous` | NodePath("") | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`GrowDirection` | :ref:`grow_horizontal` | 1 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`GrowDirection` | :ref:`grow_vertical` | 1 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`String` | :ref:`hint_tooltip` | "" | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`margin_bottom` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`margin_left` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`margin_right` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`margin_top` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | 0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`MouseFilter` | :ref:`mouse_filter` | 0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`rect_clip_content` | false | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`rect_global_position` | | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`rect_min_size` | Vector2( 0, 0 ) | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`rect_pivot_offset` | Vector2( 0, 0 ) | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`rect_position` | Vector2( 0, 0 ) | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`rect_rotation` | 0.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`rect_scale` | Vector2( 1, 1 ) | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`rect_size` | Vector2( 0, 0 ) | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`size_flags_horizontal` | 1 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`size_flags_stretch_ratio` | 1.0 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`size_flags_vertical` | 1 | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Theme` | :ref:`theme` | null | ++--------------------------------------------------+--------------------------------------------------------------------------------------+-----------------+ Methods ------- @@ -594,51 +594,61 @@ Property Descriptions - :ref:`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`. +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` **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`. +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` **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`. +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` **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`. +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` **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` **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` **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` **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` **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` **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` **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` **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` **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` **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` property is not :ref:`MOUSE_FILTER_IGNORE`. @@ -756,11 +784,13 @@ Changes the tooltip text. The tooltip appears when the user's mouse cursor stays - :ref:`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`. @@ -770,11 +800,13 @@ Margins are often controlled by one or multiple parent :ref:`Container` **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`. @@ -784,11 +816,13 @@ Margins are often controlled by one or multiple parent :ref:`Container` **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`. @@ -798,11 +832,13 @@ Margins are often controlled by one or multiple parent :ref:`Container` **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`. @@ -812,11 +848,13 @@ Margins are often controlled by one or multiple parent :ref:`Container` **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` **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` and how these events should be handled. Also controls whether the control can receive the :ref:`mouse_entered`, and :ref:`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` **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` **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` **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`, it will scale around this pivot. Set this property to :ref:`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` **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`. @@ -894,11 +942,13 @@ The node's position, relative to its parent. It corresponds to the rectangle's t - :ref:`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` to change the pivot's position. @@ -906,11 +956,13 @@ The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` **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`. Change this property to scale the node around its :ref:`rect_pivot_offset`. @@ -918,9 +970,11 @@ The node's scale, relative to its :ref:`rect_size` **rect_size** -+----------+------------+ -| *Getter* | get_size() | -+----------+------------+ ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ +| *Getter* | get_size() | ++-----------+-----------------+ The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes update this property automatically. @@ -928,11 +982,13 @@ The size of the node's bounding rectangle, in pixels. :ref:`Container` **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` 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` nodes how they should resize - :ref:`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` size flag, the parent :ref:`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` **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` 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` nodes how they should resize - :ref:`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` resource this node and all its ``Control`` children use. diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 7385d4227..f101562e0 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -19,9 +19,9 @@ Convex polygon shape for 3D physics. Properties ---------- -+-------------------------------------------------+---------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`points` | -+-------------------------------------------------+---------------------------------------------------------+ ++-------------------------------------------------+---------------------------------------------------------+----------------------+ +| :ref:`PoolVector3Array` | :ref:`points` | PoolVector3Array( ) | ++-------------------------------------------------+---------------------------------------------------------+----------------------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 99a1f7134..ba74d89e0 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -19,9 +19,9 @@ Convex polygon shape for 2D physics. Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`points` | -+-------------------------------------------------+-----------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------+----------------------+ +| :ref:`PoolVector2Array` | :ref:`points` | PoolVector2Array( ) | ++-------------------------------------------------+-----------------------------------------------------------+----------------------+ Methods ------- @@ -44,11 +44,13 @@ Property Descriptions - :ref:`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. diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index cada23dad..430b5bf36 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -19,131 +19,133 @@ CPU-based 3D particle emitter. Properties ---------- -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`amount` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`angle_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`angular_velocity_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`anim_offset_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`anim_speed_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`color_ramp` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`damping_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`emission_box_extents` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`emission_colors` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`emission_normals` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`emission_points` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`EmissionShape` | :ref:`emission_shape` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_sphere_radius` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emitting` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`explosiveness` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_fps` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_align_y` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_disable_z` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_rotate_y` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`flatness` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fract_delta` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`gravity` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`hue_variation_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lifetime` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`linear_accel_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`local_coords` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`orbit_velocity` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`orbit_velocity_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`orbit_velocity_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`preprocess` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`radial_accel_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randomness` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_amount` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`scale_amount_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_amount_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spread` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`tangential_accel_curve` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel_random` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+ ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`int` | :ref:`amount` | 8 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angle` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`angle_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angle_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angular_velocity` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`angular_velocity_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angular_velocity_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`anim_offset` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`anim_offset_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`anim_offset_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`anim_speed` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`anim_speed_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`anim_speed_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Color` | :ref:`color` | Color( 1, 1, 1, 1 ) | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Gradient` | :ref:`color_ramp` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`damping` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`damping_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`damping_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`direction` | Vector3( 1, 0, 0 ) | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | 0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`emission_box_extents` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`PoolColorArray` | :ref:`emission_colors` | PoolColorArray( ) | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`PoolVector3Array` | :ref:`emission_normals` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`PoolVector3Array` | :ref:`emission_points` | PoolVector3Array( ) | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`EmissionShape` | :ref:`emission_shape` | 0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`emission_sphere_radius` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`emitting` | true | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`explosiveness` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`int` | :ref:`fixed_fps` | 0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`flag_align_y` | false | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`flag_disable_z` | false | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`flag_rotate_y` | false | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`flatness` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`fract_delta` | true | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`gravity` | Vector3( 0, -9.8, 0 ) | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`hue_variation` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`hue_variation_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`hue_variation_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`initial_velocity` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`initial_velocity_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`lifetime` | 1.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`linear_accel` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`linear_accel_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`linear_accel_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`local_coords` | true | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Mesh` | :ref:`mesh` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`one_shot` | false | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`orbit_velocity` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`orbit_velocity_curve` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`orbit_velocity_random` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`preprocess` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`radial_accel` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`radial_accel_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`radial_accel_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`randomness` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`scale_amount` | 1.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`scale_amount_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`scale_amount_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`speed_scale` | 1.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`spread` | 45.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`tangential_accel` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Curve` | :ref:`tangential_accel_curve` | null | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`tangential_accel_random` | 0.0 | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ Methods ------- @@ -287,11 +289,13 @@ Property Descriptions - :ref:`int` **amount** -+----------+-------------------+ -| *Setter* | set_amount(value) | -+----------+-------------------+ -| *Getter* | get_amount() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 8 | ++-----------+-------------------+ +| *Setter* | set_amount(value) | ++-----------+-------------------+ +| *Getter* | get_amount() | ++-----------+-------------------+ Number of particles emitted in one emission cycle. @@ -299,11 +303,13 @@ Number of particles emitted in one emission cycle. - :ref:`float` **angle** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial rotation applied to each particle, in degrees. @@ -311,11 +317,13 @@ Initial rotation applied to each particle, in degrees. - :ref:`Curve` **angle_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's rotation will be animated along this :ref:`Curve`. @@ -323,23 +331,27 @@ Each particle's rotation will be animated along this :ref:`Curve`. - :ref:`float` **angle_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Rotation randomness ratio. Default value: ``0``. +Rotation randomness ratio. .. _class_CPUParticles_property_angular_velocity: - :ref:`float` **angular_velocity** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. @@ -347,11 +359,13 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of - :ref:`Curve` **angular_velocity_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's angular velocity will vary along this :ref:`Curve`. @@ -359,23 +373,27 @@ Each particle's angular velocity will vary along this :ref:`Curve`. - :ref:`float` **angular_velocity_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Angular velocity randomness ratio. Default value: ``0``. +Angular velocity randomness ratio. .. _class_CPUParticles_property_anim_offset: - :ref:`float` **anim_offset** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Particle animation offset. @@ -383,11 +401,13 @@ Particle animation offset. - :ref:`Curve` **anim_offset_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's animation offset will vary along this :ref:`Curve`. @@ -395,23 +415,27 @@ Each particle's animation offset will vary along this :ref:`Curve`. - :ref:`float` **anim_offset_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Animation offset randomness ratio. Default value: ``0``. +Animation offset randomness ratio. .. _class_CPUParticles_property_anim_speed: - :ref:`float` **anim_speed** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Particle animation speed. @@ -419,11 +443,13 @@ Particle animation speed. - :ref:`Curve` **anim_speed_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's animation speed will vary along this :ref:`Curve`. @@ -431,23 +457,27 @@ Each particle's animation speed will vary along this :ref:`Curve`. - :ref:`float` **anim_speed_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Animation speed randomness ratio. Default value: ``0``. +Animation speed randomness ratio. .. _class_CPUParticles_property_color: - :ref:`Color` **color** -+----------+------------------+ -| *Setter* | set_color(value) | -+----------+------------------+ -| *Getter* | get_color() | -+----------+------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_color(value) | ++-----------+---------------------+ +| *Getter* | get_color() | ++-----------+---------------------+ Unused for 3D particles. @@ -455,11 +485,13 @@ Unused for 3D particles. - :ref:`Gradient` **color_ramp** -+----------+-----------------------+ -| *Setter* | set_color_ramp(value) | -+----------+-----------------------+ -| *Getter* | get_color_ramp() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_color_ramp(value) | ++-----------+-----------------------+ +| *Getter* | get_color_ramp() | ++-----------+-----------------------+ Unused for 3D particles. @@ -467,11 +499,13 @@ Unused for 3D particles. - :ref:`float` **damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The rate at which particles lose velocity. @@ -479,11 +513,13 @@ The rate at which particles lose velocity. - :ref:`Curve` **damping_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Damping will vary along this :ref:`Curve`. @@ -491,25 +527,43 @@ Damping will vary along this :ref:`Curve`. - :ref:`float` **damping_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Damping randomness ratio. Default value: ``0``. +Damping randomness ratio. + +.. _class_CPUParticles_property_direction: + +- :ref:`Vector3` **direction** + ++-----------+----------------------+ +| *Default* | Vector3( 1, 0, 0 ) | ++-----------+----------------------+ +| *Setter* | set_direction(value) | ++-----------+----------------------+ +| *Getter* | get_direction() | ++-----------+----------------------+ + +Unit vector specifying the particles' emission direction. .. _class_CPUParticles_property_draw_order: - :ref:`DrawOrder` **draw_order** -+----------+-----------------------+ -| *Setter* | set_draw_order(value) | -+----------+-----------------------+ -| *Getter* | get_draw_order() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_draw_order(value) | ++-----------+-----------------------+ +| *Getter* | get_draw_order() | ++-----------+-----------------------+ -Particle draw order. Uses :ref:`DrawOrder` values. Default value: :ref:`DRAW_ORDER_INDEX`. +Particle draw order. Uses :ref:`DrawOrder` values. .. _class_CPUParticles_property_emission_box_extents: @@ -527,11 +581,13 @@ The rectangle's extents if :ref:`emission_shape` **emission_colors** -+----------+----------------------------+ -| *Setter* | set_emission_colors(value) | -+----------+----------------------------+ -| *Getter* | get_emission_colors() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | PoolColorArray( ) | ++-----------+----------------------------+ +| *Setter* | set_emission_colors(value) | ++-----------+----------------------------+ +| *Getter* | get_emission_colors() | ++-----------+----------------------------+ .. _class_CPUParticles_property_emission_normals: @@ -547,23 +603,27 @@ The rectangle's extents if :ref:`emission_shape` **emission_points** -+----------+----------------------------+ -| *Setter* | set_emission_points(value) | -+----------+----------------------------+ -| *Getter* | get_emission_points() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | PoolVector3Array( ) | ++-----------+----------------------------+ +| *Setter* | set_emission_points(value) | ++-----------+----------------------------+ +| *Getter* | get_emission_points() | ++-----------+----------------------------+ .. _class_CPUParticles_property_emission_shape: - :ref:`EmissionShape` **emission_shape** -+----------+---------------------------+ -| *Setter* | set_emission_shape(value) | -+----------+---------------------------+ -| *Getter* | get_emission_shape() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_emission_shape(value) | ++-----------+---------------------------+ +| *Getter* | get_emission_shape() | ++-----------+---------------------------+ -Particles will be emitted inside this region. See :ref:`EmissionShape` for possible values. Default value: :ref:`EMISSION_SHAPE_POINT`. +Particles will be emitted inside this region. See :ref:`EmissionShape` for possible values. .. _class_CPUParticles_property_emission_sphere_radius: @@ -581,35 +641,41 @@ The sphere's radius if :ref:`EmissionShape` is - :ref:`bool` **emitting** -+----------+---------------------+ -| *Setter* | set_emitting(value) | -+----------+---------------------+ -| *Getter* | is_emitting() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_emitting(value) | ++-----------+---------------------+ +| *Getter* | is_emitting() | ++-----------+---------------------+ -If ``true``, particles are being emitted. Default value: ``true``. +If ``true``, particles are being emitted. .. _class_CPUParticles_property_explosiveness: - :ref:`float` **explosiveness** -+----------+--------------------------------+ -| *Setter* | set_explosiveness_ratio(value) | -+----------+--------------------------------+ -| *Getter* | get_explosiveness_ratio() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------------+ +| *Setter* | set_explosiveness_ratio(value) | ++-----------+--------------------------------+ +| *Getter* | get_explosiveness_ratio() | ++-----------+--------------------------------+ -How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. +How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. .. _class_CPUParticles_property_fixed_fps: - :ref:`int` **fixed_fps** -+----------+----------------------+ -| *Setter* | set_fixed_fps(value) | -+----------+----------------------+ -| *Getter* | get_fixed_fps() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_fixed_fps(value) | ++-----------+----------------------+ +| *Getter* | get_fixed_fps() | ++-----------+----------------------+ The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself. @@ -617,11 +683,13 @@ The particle system's frame rate is fixed to a value. For instance, changing the - :ref:`bool` **flag_align_y** -+----------+--------------------------+ -| *Setter* | set_particle_flag(value) | -+----------+--------------------------+ -| *Getter* | get_particle_flag() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++-----------+--------------------------+ +| *Getter* | get_particle_flag() | ++-----------+--------------------------+ Align Y axis of particle with the direction of its velocity. @@ -629,23 +697,27 @@ Align Y axis of particle with the direction of its velocity. - :ref:`bool` **flag_disable_z** -+----------+--------------------------+ -| *Setter* | set_particle_flag(value) | -+----------+--------------------------+ -| *Getter* | get_particle_flag() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++-----------+--------------------------+ +| *Getter* | get_particle_flag() | ++-----------+--------------------------+ -If ``true``, particles will not move on the z axis. Default value: ``false``. +If ``true``, particles will not move on the z axis. .. _class_CPUParticles_property_flag_rotate_y: - :ref:`bool` **flag_rotate_y** -+----------+--------------------------+ -| *Setter* | set_particle_flag(value) | -+----------+--------------------------+ -| *Getter* | get_particle_flag() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++-----------+--------------------------+ +| *Getter* | get_particle_flag() | ++-----------+--------------------------+ If ``true``, particles rotate around Y axis by :ref:`angle`. @@ -653,47 +725,55 @@ If ``true``, particles rotate around Y axis by :ref:`angle` **flatness** -+----------+---------------------+ -| *Setter* | set_flatness(value) | -+----------+---------------------+ -| *Getter* | get_flatness() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_flatness(value) | ++-----------+---------------------+ +| *Getter* | get_flatness() | ++-----------+---------------------+ -Amount of :ref:`spread` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``. +Amount of :ref:`spread` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. .. _class_CPUParticles_property_fract_delta: - :ref:`bool` **fract_delta** -+----------+-----------------------------+ -| *Setter* | set_fractional_delta(value) | -+----------+-----------------------------+ -| *Getter* | get_fractional_delta() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | true | ++-----------+-----------------------------+ +| *Setter* | set_fractional_delta(value) | ++-----------+-----------------------------+ +| *Getter* | get_fractional_delta() | ++-----------+-----------------------------+ -If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true``. +If ``true``, results in fractional delta calculation which has a smoother particles display effect. .. _class_CPUParticles_property_gravity: - :ref:`Vector3` **gravity** -+----------+--------------------+ -| *Setter* | set_gravity(value) | -+----------+--------------------+ -| *Getter* | get_gravity() | -+----------+--------------------+ ++-----------+-----------------------+ +| *Default* | Vector3( 0, -9.8, 0 ) | ++-----------+-----------------------+ +| *Setter* | set_gravity(value) | ++-----------+-----------------------+ +| *Getter* | get_gravity() | ++-----------+-----------------------+ -Gravity applied to every particle. Default value: ``(0, -9.8, 0)``. +Gravity applied to every particle. .. _class_CPUParticles_property_hue_variation: - :ref:`float` **hue_variation** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial hue variation applied to each particle. @@ -701,11 +781,13 @@ Initial hue variation applied to each particle. - :ref:`Curve` **hue_variation_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's hue will vary along this :ref:`Curve`. @@ -713,23 +795,27 @@ Each particle's hue will vary along this :ref:`Curve`. - :ref:`float` **hue_variation_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Hue variation randomness ratio. Default value: ``0``. +Hue variation randomness ratio. .. _class_CPUParticles_property_initial_velocity: - :ref:`float` **initial_velocity** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial velocity magnitude for each particle. Direction comes from :ref:`spread` and the node's orientation. @@ -737,35 +823,41 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread< - :ref:`float` **initial_velocity_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Initial velocity randomness ratio. Default value: ``0``. +Initial velocity randomness ratio. .. _class_CPUParticles_property_lifetime: - :ref:`float` **lifetime** -+----------+---------------------+ -| *Setter* | set_lifetime(value) | -+----------+---------------------+ -| *Getter* | get_lifetime() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 1.0 | ++-----------+---------------------+ +| *Setter* | set_lifetime(value) | ++-----------+---------------------+ +| *Getter* | get_lifetime() | ++-----------+---------------------+ -Amount of time each particle will exist. Default value: ``1``. +Amount of time each particle will exist. .. _class_CPUParticles_property_linear_accel: - :ref:`float` **linear_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Linear acceleration applied to each particle in the direction of motion. @@ -773,11 +865,13 @@ Linear acceleration applied to each particle in the direction of motion. - :ref:`Curve` **linear_accel_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's linear acceleration will vary along this :ref:`Curve`. @@ -785,35 +879,41 @@ Each particle's linear acceleration will vary along this :ref:`Curve` **linear_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Linear acceleration randomness ratio. Default value: ``0``. +Linear acceleration randomness ratio. .. _class_CPUParticles_property_local_coords: - :ref:`bool` **local_coords** -+----------+----------------------------------+ -| *Setter* | set_use_local_coordinates(value) | -+----------+----------------------------------+ -| *Getter* | get_use_local_coordinates() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_use_local_coordinates(value) | ++-----------+----------------------------------+ +| *Getter* | get_use_local_coordinates() | ++-----------+----------------------------------+ -If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. +If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. .. _class_CPUParticles_property_mesh: - :ref:`Mesh` **mesh** -+----------+-----------------+ -| *Setter* | set_mesh(value) | -+----------+-----------------+ -| *Getter* | get_mesh() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | null | ++-----------+-----------------+ +| *Setter* | set_mesh(value) | ++-----------+-----------------+ +| *Getter* | get_mesh() | ++-----------+-----------------+ The :ref:`Mesh` used for each particle. If ``null``, particles will be spheres. @@ -821,13 +921,15 @@ The :ref:`Mesh` used for each particle. If ``null``, particles will - :ref:`bool` **one_shot** -+----------+---------------------+ -| *Setter* | set_one_shot(value) | -+----------+---------------------+ -| *Getter* | get_one_shot() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_one_shot(value) | ++-----------+---------------------+ +| *Getter* | get_one_shot() | ++-----------+---------------------+ -If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. +If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. .. _class_CPUParticles_property_orbit_velocity: @@ -865,17 +967,19 @@ Each particle's orbital velocity will vary along this :ref:`Curve`. | *Getter* | get_param_randomness() | +----------+-----------------------------+ -Orbital velocity randomness ratio. Default value: ``0``. +Orbital velocity randomness ratio. .. _class_CPUParticles_property_preprocess: - :ref:`float` **preprocess** -+----------+-----------------------------+ -| *Setter* | set_pre_process_time(value) | -+----------+-----------------------------+ -| *Getter* | get_pre_process_time() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_pre_process_time(value) | ++-----------+-----------------------------+ +| *Getter* | get_pre_process_time() | ++-----------+-----------------------------+ Particle system starts as if it had already run for this many seconds. @@ -883,11 +987,13 @@ Particle system starts as if it had already run for this many seconds. - :ref:`float` **radial_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Radial acceleration applied to each particle. Makes particle accelerate away from origin. @@ -895,11 +1001,13 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro - :ref:`Curve` **radial_accel_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's radial acceleration will vary along this :ref:`Curve`. @@ -907,35 +1015,41 @@ Each particle's radial acceleration will vary along this :ref:`Curve` **radial_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Radial acceleration randomness ratio. Default value: ``0``. +Radial acceleration randomness ratio. .. _class_CPUParticles_property_randomness: - :ref:`float` **randomness** -+----------+-----------------------------+ -| *Setter* | set_randomness_ratio(value) | -+----------+-----------------------------+ -| *Getter* | get_randomness_ratio() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_randomness_ratio(value) | ++-----------+-----------------------------+ +| *Getter* | get_randomness_ratio() | ++-----------+-----------------------------+ -Emission lifetime randomness ratio. Default value: ``0``. +Emission lifetime randomness ratio. .. _class_CPUParticles_property_scale_amount: - :ref:`float` **scale_amount** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial scale applied to each particle. @@ -943,11 +1057,13 @@ Initial scale applied to each particle. - :ref:`Curve` **scale_amount_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's scale will vary along this :ref:`Curve`. @@ -955,47 +1071,55 @@ Each particle's scale will vary along this :ref:`Curve`. - :ref:`float` **scale_amount_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Scale randomness ratio. Default value: ``0``. +Scale randomness ratio. .. _class_CPUParticles_property_speed_scale: - :ref:`float` **speed_scale** -+----------+------------------------+ -| *Setter* | set_speed_scale(value) | -+----------+------------------------+ -| *Getter* | get_speed_scale() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1.0 | ++-----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++-----------+------------------------+ +| *Getter* | get_speed_scale() | ++-----------+------------------------+ -Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +Particle system's running speed scaling ratio. A value of ``0`` can be used to pause the particles. .. _class_CPUParticles_property_spread: - :ref:`float` **spread** -+----------+-------------------+ -| *Setter* | set_spread(value) | -+----------+-------------------+ -| *Getter* | get_spread() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 45.0 | ++-----------+-------------------+ +| *Setter* | set_spread(value) | ++-----------+-------------------+ +| *Getter* | get_spread() | ++-----------+-------------------+ -Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. +Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Applied to X/Z plane and Y/Z planes. .. _class_CPUParticles_property_tangential_accel: - :ref:`float` **tangential_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. @@ -1003,11 +1127,13 @@ Tangential acceleration applied to each particle. Tangential acceleration is per - :ref:`Curve` **tangential_accel_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's tangential acceleration will vary along this :ref:`Curve`. @@ -1015,13 +1141,15 @@ Each particle's tangential acceleration will vary along this :ref:`Curve` **tangential_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Tangential acceleration randomness ratio. Default value: ``0``. +Tangential acceleration randomness ratio. Method Descriptions ------------------- diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index c6b6a58ef..4bdd51ff6 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -19,129 +19,131 @@ CPU-based 2D particle emitter. Properties ---------- -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`amount` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`angle_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`angular_velocity_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`anim_offset_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`anim_speed_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`color_ramp` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`damping_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`emission_colors` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`emission_normals` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`emission_points` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`emission_rect_extents` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`EmissionShape` | :ref:`emission_shape` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_sphere_radius` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emitting` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`explosiveness` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_fps` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_align_y` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`flatness` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fract_delta` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`gravity` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`hue_variation_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lifetime` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`linear_accel_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`local_coords` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normalmap` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`orbit_velocity` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`orbit_velocity_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`orbit_velocity_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`preprocess` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`radial_accel_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randomness` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_amount` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`scale_amount_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_amount_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spread` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`tangential_accel_curve` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel_random` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+---------------------------------------------------------+---------------------------------------------------------------------------------------+ ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`amount` | 8 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`angle` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`angle_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`angle_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`angular_velocity` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`angular_velocity_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`angular_velocity_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`anim_offset` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`anim_offset_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`anim_offset_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`anim_speed` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`anim_speed_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`anim_speed_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`color` | Color( 1, 1, 1, 1 ) | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Gradient` | :ref:`color_ramp` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`damping` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`damping_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`damping_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`direction` | Vector2( 1, 0 ) | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | 0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`PoolColorArray` | :ref:`emission_colors` | | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`PoolVector2Array` | :ref:`emission_normals` | | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`PoolVector2Array` | :ref:`emission_points` | | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`emission_rect_extents` | | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`EmissionShape` | :ref:`emission_shape` | 0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`emission_sphere_radius` | | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`emitting` | true | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`explosiveness` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`fixed_fps` | 0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flag_align_y` | false | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`flatness` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`fract_delta` | true | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`gravity` | Vector2( 0, 98 ) | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`hue_variation` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`hue_variation_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`hue_variation_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`initial_velocity` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`initial_velocity_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`lifetime` | 1.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`linear_accel` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`linear_accel_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`linear_accel_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`local_coords` | true | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`normalmap` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`one_shot` | false | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`orbit_velocity` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`orbit_velocity_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`orbit_velocity_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`preprocess` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`radial_accel` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`radial_accel_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`radial_accel_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`randomness` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`scale_amount` | 1.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`scale_amount_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`scale_amount_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`speed_scale` | 1.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`spread` | 45.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`tangential_accel` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Curve` | :ref:`tangential_accel_curve` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`tangential_accel_random` | 0.0 | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------+ Methods ------- @@ -286,11 +288,13 @@ Property Descriptions - :ref:`int` **amount** -+----------+-------------------+ -| *Setter* | set_amount(value) | -+----------+-------------------+ -| *Getter* | get_amount() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 8 | ++-----------+-------------------+ +| *Setter* | set_amount(value) | ++-----------+-------------------+ +| *Getter* | get_amount() | ++-----------+-------------------+ Number of particles emitted in one emission cycle. @@ -298,11 +302,13 @@ Number of particles emitted in one emission cycle. - :ref:`float` **angle** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial rotation applied to each particle, in degrees. @@ -310,11 +316,13 @@ Initial rotation applied to each particle, in degrees. - :ref:`Curve` **angle_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's rotation will be animated along this :ref:`Curve`. @@ -322,23 +330,27 @@ Each particle's rotation will be animated along this :ref:`Curve`. - :ref:`float` **angle_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Rotation randomness ratio. Default value: ``0``. +Rotation randomness ratio. .. _class_CPUParticles2D_property_angular_velocity: - :ref:`float` **angular_velocity** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. @@ -346,11 +358,13 @@ Initial angular velocity applied to each particle. Sets the speed of rotation of - :ref:`Curve` **angular_velocity_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's angular velocity will vary along this :ref:`Curve`. @@ -358,23 +372,27 @@ Each particle's angular velocity will vary along this :ref:`Curve`. - :ref:`float` **angular_velocity_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Angular velocity randomness ratio. Default value: ``0``. +Angular velocity randomness ratio. .. _class_CPUParticles2D_property_anim_offset: - :ref:`float` **anim_offset** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Particle animation offset. @@ -382,11 +400,13 @@ Particle animation offset. - :ref:`Curve` **anim_offset_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's animation offset will vary along this :ref:`Curve`. @@ -394,23 +414,27 @@ Each particle's animation offset will vary along this :ref:`Curve`. - :ref:`float` **anim_offset_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Animation offset randomness ratio. Default value: ``0``. +Animation offset randomness ratio. .. _class_CPUParticles2D_property_anim_speed: - :ref:`float` **anim_speed** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Particle animation speed. @@ -418,11 +442,13 @@ Particle animation speed. - :ref:`Curve` **anim_speed_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's animation speed will vary along this :ref:`Curve`. @@ -430,23 +456,27 @@ Each particle's animation speed will vary along this :ref:`Curve`. - :ref:`float` **anim_speed_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Animation speed randomness ratio. Default value: ``0``. +Animation speed randomness ratio. .. _class_CPUParticles2D_property_color: - :ref:`Color` **color** -+----------+------------------+ -| *Setter* | set_color(value) | -+----------+------------------+ -| *Getter* | get_color() | -+----------+------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_color(value) | ++-----------+---------------------+ +| *Getter* | get_color() | ++-----------+---------------------+ Each particle's initial color. If :ref:`texture` is defined, it will be multiplied by this color. @@ -454,11 +484,13 @@ Each particle's initial color. If :ref:`texture` **color_ramp** -+----------+-----------------------+ -| *Setter* | set_color_ramp(value) | -+----------+-----------------------+ -| *Getter* | get_color_ramp() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_color_ramp(value) | ++-----------+-----------------------+ +| *Getter* | get_color_ramp() | ++-----------+-----------------------+ Each particle's color will vary along this :ref:`Gradient`. @@ -466,11 +498,13 @@ Each particle's color will vary along this :ref:`Gradient`. - :ref:`float` **damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The rate at which particles lose velocity. @@ -478,11 +512,13 @@ The rate at which particles lose velocity. - :ref:`Curve` **damping_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Damping will vary along this :ref:`Curve`. @@ -490,25 +526,43 @@ Damping will vary along this :ref:`Curve`. - :ref:`float` **damping_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Damping randomness ratio. Default value: ``0``. +Damping randomness ratio. + +.. _class_CPUParticles2D_property_direction: + +- :ref:`Vector2` **direction** + ++-----------+----------------------+ +| *Default* | Vector2( 1, 0 ) | ++-----------+----------------------+ +| *Setter* | set_direction(value) | ++-----------+----------------------+ +| *Getter* | get_direction() | ++-----------+----------------------+ + +Unit vector specifying the particles' emission direction. .. _class_CPUParticles2D_property_draw_order: - :ref:`DrawOrder` **draw_order** -+----------+-----------------------+ -| *Setter* | set_draw_order(value) | -+----------+-----------------------+ -| *Getter* | get_draw_order() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_draw_order(value) | ++-----------+-----------------------+ +| *Getter* | get_draw_order() | ++-----------+-----------------------+ -Particle draw order. Uses :ref:`DrawOrder` values. Default value: :ref:`DRAW_ORDER_INDEX`. +Particle draw order. Uses :ref:`DrawOrder` values. .. _class_CPUParticles2D_property_emission_colors: @@ -556,13 +610,15 @@ The rectangle's extents if :ref:`emission_shape` **emission_shape** -+----------+---------------------------+ -| *Setter* | set_emission_shape(value) | -+----------+---------------------------+ -| *Getter* | get_emission_shape() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_emission_shape(value) | ++-----------+---------------------------+ +| *Getter* | get_emission_shape() | ++-----------+---------------------------+ -Particles will be emitted inside this region. See :ref:`EmissionShape` for possible values. Default value: :ref:`EMISSION_SHAPE_POINT`. +Particles will be emitted inside this region. See :ref:`EmissionShape` for possible values. .. _class_CPUParticles2D_property_emission_sphere_radius: @@ -580,35 +636,41 @@ The sphere's radius if :ref:`emission_shape` **emitting** -+----------+---------------------+ -| *Setter* | set_emitting(value) | -+----------+---------------------+ -| *Getter* | is_emitting() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_emitting(value) | ++-----------+---------------------+ +| *Getter* | is_emitting() | ++-----------+---------------------+ -If ``true``, particles are being emitted. Default value: ``true``. +If ``true``, particles are being emitted. .. _class_CPUParticles2D_property_explosiveness: - :ref:`float` **explosiveness** -+----------+--------------------------------+ -| *Setter* | set_explosiveness_ratio(value) | -+----------+--------------------------------+ -| *Getter* | get_explosiveness_ratio() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------------+ +| *Setter* | set_explosiveness_ratio(value) | ++-----------+--------------------------------+ +| *Getter* | get_explosiveness_ratio() | ++-----------+--------------------------------+ -How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. +How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. .. _class_CPUParticles2D_property_fixed_fps: - :ref:`int` **fixed_fps** -+----------+----------------------+ -| *Setter* | set_fixed_fps(value) | -+----------+----------------------+ -| *Getter* | get_fixed_fps() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_fixed_fps(value) | ++-----------+----------------------+ +| *Getter* | get_fixed_fps() | ++-----------+----------------------+ The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. @@ -616,11 +678,13 @@ The particle system's frame rate is fixed to a value. For instance, changing the - :ref:`bool` **flag_align_y** -+----------+--------------------------+ -| *Setter* | set_particle_flag(value) | -+----------+--------------------------+ -| *Getter* | get_particle_flag() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++-----------+--------------------------+ +| *Getter* | get_particle_flag() | ++-----------+--------------------------+ Align Y axis of particle with the direction of its velocity. @@ -628,45 +692,53 @@ Align Y axis of particle with the direction of its velocity. - :ref:`float` **flatness** -+----------+---------------------+ -| *Setter* | set_flatness(value) | -+----------+---------------------+ -| *Getter* | get_flatness() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_flatness(value) | ++-----------+---------------------+ +| *Getter* | get_flatness() | ++-----------+---------------------+ .. _class_CPUParticles2D_property_fract_delta: - :ref:`bool` **fract_delta** -+----------+-----------------------------+ -| *Setter* | set_fractional_delta(value) | -+----------+-----------------------------+ -| *Getter* | get_fractional_delta() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | true | ++-----------+-----------------------------+ +| *Setter* | set_fractional_delta(value) | ++-----------+-----------------------------+ +| *Getter* | get_fractional_delta() | ++-----------+-----------------------------+ -If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true``. +If ``true``, results in fractional delta calculation which has a smoother particles display effect. .. _class_CPUParticles2D_property_gravity: - :ref:`Vector2` **gravity** -+----------+--------------------+ -| *Setter* | set_gravity(value) | -+----------+--------------------+ -| *Getter* | get_gravity() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | Vector2( 0, 98 ) | ++-----------+--------------------+ +| *Setter* | set_gravity(value) | ++-----------+--------------------+ +| *Getter* | get_gravity() | ++-----------+--------------------+ -Gravity applied to every particle. Default value: ``(0, 98)``. +Gravity applied to every particle. .. _class_CPUParticles2D_property_hue_variation: - :ref:`float` **hue_variation** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial hue variation applied to each particle. @@ -674,11 +746,13 @@ Initial hue variation applied to each particle. - :ref:`Curve` **hue_variation_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's hue will vary along this :ref:`Curve`. @@ -686,23 +760,27 @@ Each particle's hue will vary along this :ref:`Curve`. - :ref:`float` **hue_variation_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Hue variation randomness ratio. Default value: ``0``. +Hue variation randomness ratio. .. _class_CPUParticles2D_property_initial_velocity: - :ref:`float` **initial_velocity** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial velocity magnitude for each particle. Direction comes from :ref:`spread` and the node's orientation. @@ -710,35 +788,41 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread< - :ref:`float` **initial_velocity_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Initial velocity randomness ratio. Default value: ``0``. +Initial velocity randomness ratio. .. _class_CPUParticles2D_property_lifetime: - :ref:`float` **lifetime** -+----------+---------------------+ -| *Setter* | set_lifetime(value) | -+----------+---------------------+ -| *Getter* | get_lifetime() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 1.0 | ++-----------+---------------------+ +| *Setter* | set_lifetime(value) | ++-----------+---------------------+ +| *Getter* | get_lifetime() | ++-----------+---------------------+ -Amount of time each particle will exist. Default value: ``1``. +Amount of time each particle will exist. .. _class_CPUParticles2D_property_linear_accel: - :ref:`float` **linear_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Linear acceleration applied to each particle in the direction of motion. @@ -746,11 +830,13 @@ Linear acceleration applied to each particle in the direction of motion. - :ref:`Curve` **linear_accel_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's linear acceleration will vary along this :ref:`Curve`. @@ -758,35 +844,41 @@ Each particle's linear acceleration will vary along this :ref:`Curve` **linear_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Linear acceleration randomness ratio. Default value: ``0``. +Linear acceleration randomness ratio. .. _class_CPUParticles2D_property_local_coords: - :ref:`bool` **local_coords** -+----------+----------------------------------+ -| *Setter* | set_use_local_coordinates(value) | -+----------+----------------------------------+ -| *Getter* | get_use_local_coordinates() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_use_local_coordinates(value) | ++-----------+----------------------------------+ +| *Getter* | get_use_local_coordinates() | ++-----------+----------------------------------+ -If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. +If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. .. _class_CPUParticles2D_property_normalmap: - :ref:`Texture` **normalmap** -+----------+----------------------+ -| *Setter* | set_normalmap(value) | -+----------+----------------------+ -| *Getter* | get_normalmap() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | null | ++-----------+----------------------+ +| *Setter* | set_normalmap(value) | ++-----------+----------------------+ +| *Getter* | get_normalmap() | ++-----------+----------------------+ Normal map to be used for the :ref:`texture` property. @@ -794,23 +886,27 @@ Normal map to be used for the :ref:`texture` **one_shot** -+----------+---------------------+ -| *Setter* | set_one_shot(value) | -+----------+---------------------+ -| *Getter* | get_one_shot() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_one_shot(value) | ++-----------+---------------------+ +| *Getter* | get_one_shot() | ++-----------+---------------------+ -If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. +If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. .. _class_CPUParticles2D_property_orbit_velocity: - :ref:`float` **orbit_velocity** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. @@ -818,11 +914,13 @@ Orbital velocity applied to each particle. Makes the particles circle around ori - :ref:`Curve` **orbit_velocity_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's orbital velocity will vary along this :ref:`Curve`. @@ -830,23 +928,27 @@ Each particle's orbital velocity will vary along this :ref:`Curve`. - :ref:`float` **orbit_velocity_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Orbital velocity randomness ratio. Default value: ``0``. +Orbital velocity randomness ratio. .. _class_CPUParticles2D_property_preprocess: - :ref:`float` **preprocess** -+----------+-----------------------------+ -| *Setter* | set_pre_process_time(value) | -+----------+-----------------------------+ -| *Getter* | get_pre_process_time() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_pre_process_time(value) | ++-----------+-----------------------------+ +| *Getter* | get_pre_process_time() | ++-----------+-----------------------------+ Particle system starts as if it had already run for this many seconds. @@ -854,11 +956,13 @@ Particle system starts as if it had already run for this many seconds. - :ref:`float` **radial_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Radial acceleration applied to each particle. Makes particle accelerate away from origin. @@ -866,11 +970,13 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro - :ref:`Curve` **radial_accel_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's radial acceleration will vary along this :ref:`Curve`. @@ -878,35 +984,41 @@ Each particle's radial acceleration will vary along this :ref:`Curve` **radial_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Radial acceleration randomness ratio. Default value: ``0``. +Radial acceleration randomness ratio. .. _class_CPUParticles2D_property_randomness: - :ref:`float` **randomness** -+----------+-----------------------------+ -| *Setter* | set_randomness_ratio(value) | -+----------+-----------------------------+ -| *Getter* | get_randomness_ratio() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_randomness_ratio(value) | ++-----------+-----------------------------+ +| *Getter* | get_randomness_ratio() | ++-----------+-----------------------------+ -Emission lifetime randomness ratio. Default value: ``0``. +Emission lifetime randomness ratio. .. _class_CPUParticles2D_property_scale_amount: - :ref:`float` **scale_amount** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial scale applied to each particle. @@ -914,11 +1026,13 @@ Initial scale applied to each particle. - :ref:`Curve` **scale_amount_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's scale will vary along this :ref:`Curve`. @@ -926,47 +1040,55 @@ Each particle's scale will vary along this :ref:`Curve`. - :ref:`float` **scale_amount_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Scale randomness ratio. Default value: ``0``. +Scale randomness ratio. .. _class_CPUParticles2D_property_speed_scale: - :ref:`float` **speed_scale** -+----------+------------------------+ -| *Setter* | set_speed_scale(value) | -+----------+------------------------+ -| *Getter* | get_speed_scale() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1.0 | ++-----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++-----------+------------------------+ +| *Getter* | get_speed_scale() | ++-----------+------------------------+ -Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +Particle system's running speed scaling ratio. A value of ``0`` can be used to pause the particles. .. _class_CPUParticles2D_property_spread: - :ref:`float` **spread** -+----------+-------------------+ -| *Setter* | set_spread(value) | -+----------+-------------------+ -| *Getter* | get_spread() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 45.0 | ++-----------+-------------------+ +| *Setter* | set_spread(value) | ++-----------+-------------------+ +| *Getter* | get_spread() | ++-----------+-------------------+ -Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. +Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. _class_CPUParticles2D_property_tangential_accel: - :ref:`float` **tangential_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. @@ -974,11 +1096,13 @@ Tangential acceleration applied to each particle. Tangential acceleration is per - :ref:`Curve` **tangential_accel_curve** -+----------+------------------------+ -| *Setter* | set_param_curve(value) | -+----------+------------------------+ -| *Getter* | get_param_curve() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_param_curve(value) | ++-----------+------------------------+ +| *Getter* | get_param_curve() | ++-----------+------------------------+ Each particle's tangential acceleration will vary along this :ref:`Curve`. @@ -986,23 +1110,27 @@ Each particle's tangential acceleration will vary along this :ref:`Curve` **tangential_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Tangential acceleration randomness ratio. Default value: ``0``. +Tangential acceleration randomness ratio. .. _class_CPUParticles2D_property_texture: - :ref:`Texture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ Particle texture. If ``null``, particles will be squares. diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index 21959b564..26002fbd4 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -19,15 +19,15 @@ A CSG Box shape. Properties ---------- -+---------------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`depth` | -+---------------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------------+-------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`width` | -+---------------------------------+-------------------------------------------------+ ++---------------------------------+-------------------------------------------------+------+ +| :ref:`float` | :ref:`depth` | 2.0 | ++---------------------------------+-------------------------------------------------+------+ +| :ref:`float` | :ref:`height` | 2.0 | ++---------------------------------+-------------------------------------------------+------+ +| :ref:`Material` | :ref:`material` | null | ++---------------------------------+-------------------------------------------------+------+ +| :ref:`float` | :ref:`width` | 2.0 | ++---------------------------------+-------------------------------------------------+------+ Description ----------- @@ -41,11 +41,13 @@ Property Descriptions - :ref:`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` **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` **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` **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. diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index f88d6cbd7..3b222ca8f 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -19,19 +19,19 @@ A CSG Cylinder shape. Properties ---------- -+---------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`cone` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`sides` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | -+---------------------------------+--------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`cone` | false | ++---------------------------------+--------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`height` | 1.0 | ++---------------------------------+--------------------------------------------------------------+-------+ +| :ref:`Material` | :ref:`material` | null | ++---------------------------------+--------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`radius` | 1.0 | ++---------------------------------+--------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`sides` | 8 | ++---------------------------------+--------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`smooth_faces` | true | ++---------------------------------+--------------------------------------------------------------+-------+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`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` will only apply to one side. @@ -57,11 +59,13 @@ If ``true`` a cone is created, the :ref:`radius` **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` **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` **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` **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` **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. diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index 009663ede..0c6923c1b 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -19,11 +19,11 @@ A CSG Mesh shape that uses a mesh resource. Properties ---------- -+---------------------------------+--------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+--------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+---------------------------------+--------------------------------------------------+ ++---------------------------------+--------------------------------------------------+------+ +| :ref:`Material` | :ref:`material` | null | ++---------------------------------+--------------------------------------------------+------+ +| :ref:`Mesh` | :ref:`mesh` | null | ++---------------------------------+--------------------------------------------------+------+ Description ----------- @@ -37,21 +37,25 @@ Property Descriptions - :ref:`Material` **material** -+----------+---------------------+ -| *Setter* | set_material(value) | -+----------+---------------------+ -| *Getter* | get_material() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_material(value) | ++-----------+---------------------+ +| *Getter* | get_material() | ++-----------+---------------------+ .. _class_CSGMesh_property_mesh: - :ref:`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. diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index 7e54c54f3..d1cad2f1b 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -19,33 +19,33 @@ Extrudes a 2D polygon shape to create a 3D mesh. Properties ---------- -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`depth` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`path_continuous_u` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`path_interval` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`path_joined` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`path_local` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`path_node` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`PathRotation` | :ref:`path_rotation` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`spin_degrees` | -+---------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`spin_sides` | -+---------------------------------------------------+-----------------------------------------------------------------------+ ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`depth` | 1.0 | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`Material` | :ref:`material` | null | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | 0 | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`bool` | :ref:`path_continuous_u` | | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`path_interval` | | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`bool` | :ref:`path_joined` | | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`bool` | :ref:`path_local` | | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`NodePath` | :ref:`path_node` | | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`PathRotation` | :ref:`path_rotation` | | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | PoolVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 ) | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`bool` | :ref:`smooth_faces` | false | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`spin_degrees` | | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ +| :ref:`int` | :ref:`spin_sides` | | ++---------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------+ Enumerations ------------ @@ -94,11 +94,13 @@ Property Descriptions - :ref:`float` **depth** -+----------+------------------+ -| *Setter* | set_depth(value) | -+----------+------------------+ -| *Getter* | get_depth() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_depth(value) | ++-----------+------------------+ +| *Getter* | get_depth() | ++-----------+------------------+ Extrusion depth when :ref:`mode` is :ref:`MODE_DEPTH`. @@ -106,11 +108,13 @@ Extrusion depth when :ref:`mode` is :ref:`MODE_D - :ref:`Material` **material** -+----------+---------------------+ -| *Setter* | set_material(value) | -+----------+---------------------+ -| *Getter* | get_material() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_material(value) | ++-----------+---------------------+ +| *Getter* | get_material() | ++-----------+---------------------+ Material to use for the resulting mesh. @@ -118,11 +122,13 @@ Material to use for the resulting mesh. - :ref:`Mode` **mode** -+----------+-----------------+ -| *Setter* | set_mode(value) | -+----------+-----------------+ -| *Getter* | get_mode() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_mode(value) | ++-----------+-----------------+ +| *Getter* | get_mode() | ++-----------+-----------------+ Extrusion mode. @@ -202,11 +208,13 @@ The method by which each slice is rotated along the path when :ref:`mode` **polygon** -+----------+--------------------+ -| *Setter* | set_polygon(value) | -+----------+--------------------+ -| *Getter* | get_polygon() | -+----------+--------------------+ ++-----------+--------------------------------------------+ +| *Default* | PoolVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 ) | ++-----------+--------------------------------------------+ +| *Setter* | set_polygon(value) | ++-----------+--------------------------------------------+ +| *Getter* | get_polygon() | ++-----------+--------------------------------------------+ Point array that defines the shape that we'll extrude. @@ -214,11 +222,13 @@ Point array that defines the shape that we'll extrude. - :ref:`bool` **smooth_faces** -+----------+-------------------------+ -| *Setter* | set_smooth_faces(value) | -+----------+-------------------------+ -| *Getter* | get_smooth_faces() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_smooth_faces(value) | ++-----------+-------------------------+ +| *Getter* | get_smooth_faces() | ++-----------+-------------------------+ Generates smooth normals so smooth shading is applied to our mesh. diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index 01596feb1..f31f0c183 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -21,9 +21,9 @@ Base class for CSG primitives. Properties ---------- -+-------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`invert_faces` | -+-------------------------+---------------------------------------------------------------+ ++-------------------------+---------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`invert_faces` | false | ++-------------------------+---------------------------------------------------------------+-------+ Property Descriptions --------------------- @@ -32,11 +32,13 @@ Property Descriptions - :ref:`bool` **invert_faces** -+----------+-------------------------+ -| *Setter* | set_invert_faces(value) | -+----------+-------------------------+ -| *Getter* | is_inverting_faces() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_invert_faces(value) | ++-----------+-------------------------+ +| *Getter* | is_inverting_faces() | ++-----------+-------------------------+ Invert the faces of the mesh. diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index 58999b13c..2b0526f6d 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -21,19 +21,19 @@ The CSG base class. Properties ---------- -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`calculate_tangents` | -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Operation` | :ref:`operation` | -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`snap` | -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_collision` | -+-------------------------------------------+-----------------------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`calculate_tangents` | true | ++-------------------------------------------+-----------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++-------------------------------------------+-----------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++-------------------------------------------+-----------------------------------------------------------------------+-------+ +| :ref:`Operation` | :ref:`operation` | 0 | ++-------------------------------------------+-----------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`snap` | 0.001 | ++-------------------------------------------+-----------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`use_collision` | false | ++-------------------------------------------+-----------------------------------------------------------------------+-------+ Methods ------- @@ -83,11 +83,13 @@ Property Descriptions - :ref:`bool` **calculate_tangents** -+----------+-------------------------------+ -| *Setter* | set_calculate_tangents(value) | -+----------+-------------------------------+ -| *Getter* | is_calculating_tangents() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | true | ++-----------+-------------------------------+ +| *Setter* | set_calculate_tangents(value) | ++-----------+-------------------------------+ +| *Getter* | is_calculating_tangents() | ++-----------+-------------------------------+ Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. @@ -95,11 +97,13 @@ Calculate tangents for the CSG shape which allows the use of normal maps. This i - :ref:`int` **collision_layer** -+----------+----------------------------+ -| *Setter* | set_collision_layer(value) | -+----------+----------------------------+ -| *Getter* | get_collision_layer() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1 | ++-----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++-----------+----------------------------+ +| *Getter* | get_collision_layer() | ++-----------+----------------------------+ The physics layers this area is in. @@ -111,11 +115,13 @@ A contact is detected if object A is in any of the layers that object B scans, o - :ref:`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 CSG shape scans for collisions. @@ -123,11 +129,13 @@ The physics layers this CSG shape scans for collisions. - :ref:`Operation` **operation** -+----------+----------------------+ -| *Setter* | set_operation(value) | -+----------+----------------------+ -| *Getter* | get_operation() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_operation(value) | ++-----------+----------------------+ +| *Getter* | get_operation() | ++-----------+----------------------+ The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. @@ -135,21 +143,25 @@ The operation that is performed on this shape. This is ignored for the first CSG - :ref:`float` **snap** -+----------+-----------------+ -| *Setter* | set_snap(value) | -+----------+-----------------+ -| *Getter* | get_snap() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0.001 | ++-----------+-----------------+ +| *Setter* | set_snap(value) | ++-----------+-----------------+ +| *Getter* | get_snap() | ++-----------+-----------------+ .. _class_CSGShape_property_use_collision: - :ref:`bool` **use_collision** -+----------+--------------------------+ -| *Setter* | set_use_collision(value) | -+----------+--------------------------+ -| *Getter* | is_using_collision() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_use_collision(value) | ++-----------+--------------------------+ +| *Getter* | is_using_collision() | ++-----------+--------------------------+ Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index 3d26b0613..9413bb513 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -19,17 +19,17 @@ A CSG Sphere shape. Properties ---------- -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`radial_segments` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`rings` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | -+---------------------------------+------------------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------+------+ +| :ref:`Material` | :ref:`material` | null | ++---------------------------------+------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`radial_segments` | 12 | ++---------------------------------+------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`radius` | 1.0 | ++---------------------------------+------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`rings` | 6 | ++---------------------------------+------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`smooth_faces` | true | ++---------------------------------+------------------------------------------------------------------+------+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`Material` **material** -+----------+---------------------+ -| *Setter* | set_material(value) | -+----------+---------------------+ -| *Getter* | get_material() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_material(value) | ++-----------+---------------------+ +| *Getter* | get_material() | ++-----------+---------------------+ The material used to render the sphere. @@ -55,11 +57,13 @@ The material used to render the sphere. - :ref:`int` **radial_segments** -+----------+----------------------------+ -| *Setter* | set_radial_segments(value) | -+----------+----------------------------+ -| *Getter* | get_radial_segments() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 12 | ++-----------+----------------------------+ +| *Setter* | set_radial_segments(value) | ++-----------+----------------------------+ +| *Getter* | get_radial_segments() | ++-----------+----------------------------+ Number of vertical slices for the sphere. @@ -67,11 +71,13 @@ Number of vertical slices for the sphere. - :ref:`float` **radius** -+----------+-------------------+ -| *Setter* | set_radius(value) | -+----------+-------------------+ -| *Getter* | get_radius() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ Radius of the sphere. @@ -79,11 +85,13 @@ Radius of the sphere. - :ref:`int` **rings** -+----------+------------------+ -| *Setter* | set_rings(value) | -+----------+------------------+ -| *Getter* | get_rings() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 6 | ++-----------+------------------+ +| *Setter* | set_rings(value) | ++-----------+------------------+ +| *Getter* | get_rings() | ++-----------+------------------+ Number of horizontal slices for the sphere. @@ -91,11 +99,13 @@ Number of horizontal slices for the sphere. - :ref:`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 sphere are set to give a smooth effect making the sphere seem rounded. If ``false`` the sphere will have a flat shaded look. diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index 0672f72a3..44f8a788f 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -19,19 +19,19 @@ A CSG Torus shape. Properties ---------- -+---------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`inner_radius` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`outer_radius` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`ring_sides` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`sides` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | -+---------------------------------+-----------------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------+------+ +| :ref:`float` | :ref:`inner_radius` | 2.0 | ++---------------------------------+-----------------------------------------------------------+------+ +| :ref:`Material` | :ref:`material` | null | ++---------------------------------+-----------------------------------------------------------+------+ +| :ref:`float` | :ref:`outer_radius` | 3.0 | ++---------------------------------+-----------------------------------------------------------+------+ +| :ref:`int` | :ref:`ring_sides` | 6 | ++---------------------------------+-----------------------------------------------------------+------+ +| :ref:`int` | :ref:`sides` | 8 | ++---------------------------------+-----------------------------------------------------------+------+ +| :ref:`bool` | :ref:`smooth_faces` | true | ++---------------------------------+-----------------------------------------------------------+------+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`float` **inner_radius** -+----------+-------------------------+ -| *Setter* | set_inner_radius(value) | -+----------+-------------------------+ -| *Getter* | get_inner_radius() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 2.0 | ++-----------+-------------------------+ +| *Setter* | set_inner_radius(value) | ++-----------+-------------------------+ +| *Getter* | get_inner_radius() | ++-----------+-------------------------+ The inner radius of the torus. @@ -57,11 +59,13 @@ The inner radius of the torus. - :ref:`Material` **material** -+----------+---------------------+ -| *Setter* | set_material(value) | -+----------+---------------------+ -| *Getter* | get_material() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_material(value) | ++-----------+---------------------+ +| *Getter* | get_material() | ++-----------+---------------------+ The material used to render the torus. @@ -69,11 +73,13 @@ The material used to render the torus. - :ref:`float` **outer_radius** -+----------+-------------------------+ -| *Setter* | set_outer_radius(value) | -+----------+-------------------------+ -| *Getter* | get_outer_radius() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 3.0 | ++-----------+-------------------------+ +| *Setter* | set_outer_radius(value) | ++-----------+-------------------------+ +| *Getter* | get_outer_radius() | ++-----------+-------------------------+ The outer radius of the torus. @@ -81,11 +87,13 @@ The outer radius of the torus. - :ref:`int` **ring_sides** -+----------+-----------------------+ -| *Setter* | set_ring_sides(value) | -+----------+-----------------------+ -| *Getter* | get_ring_sides() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 6 | ++-----------+-----------------------+ +| *Setter* | set_ring_sides(value) | ++-----------+-----------------------+ +| *Getter* | get_ring_sides() | ++-----------+-----------------------+ The number of edges each ring of the torus is constructed of. @@ -93,11 +101,13 @@ The number of edges each ring of the torus is constructed of. - :ref:`int` **sides** -+----------+------------------+ -| *Setter* | set_sides(value) | -+----------+------------------+ -| *Getter* | get_sides() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 8 | ++-----------+------------------+ +| *Setter* | set_sides(value) | ++-----------+------------------+ +| *Getter* | get_sides() | ++-----------+------------------+ The number of slices the torus is constructed of. @@ -105,11 +115,13 @@ The number of slices the torus is constructed of. - :ref:`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 torus are set to give a smooth effect making the torus seem rounded. If ``false`` the torus will have a flat shaded look. diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index da411de9c..99580cfb9 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -19,13 +19,13 @@ A CubeMap is a 6-sided 3D texture. Properties ---------- -+--------------------------------------+----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`flags` | -+--------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lossy_storage_quality` | -+--------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Storage` | :ref:`storage_mode` | -+--------------------------------------+----------------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`flags` | 7 | ++--------------------------------------+----------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`lossy_storage_quality` | 0.7 | ++--------------------------------------+----------------------------------------------------------------------------+-----+ +| :ref:`Storage` | :ref:`storage_mode` | 0 | ++--------------------------------------+----------------------------------------------------------------------------+-----+ Methods ------- @@ -119,11 +119,13 @@ Property Descriptions - :ref:`int` **flags** -+----------+------------------+ -| *Setter* | set_flags(value) | -+----------+------------------+ -| *Getter* | get_flags() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 7 | ++-----------+------------------+ +| *Setter* | set_flags(value) | ++-----------+------------------+ +| *Getter* | get_flags() | ++-----------+------------------+ The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. @@ -131,11 +133,13 @@ The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. - :ref:`float` **lossy_storage_quality** -+----------+----------------------------------+ -| *Setter* | set_lossy_storage_quality(value) | -+----------+----------------------------------+ -| *Getter* | get_lossy_storage_quality() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 0.7 | ++-----------+----------------------------------+ +| *Setter* | set_lossy_storage_quality(value) | ++-----------+----------------------------------+ +| *Getter* | get_lossy_storage_quality() | ++-----------+----------------------------------+ The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. @@ -143,11 +147,13 @@ The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORA - :ref:`Storage` **storage_mode** -+----------+--------------------+ -| *Setter* | set_storage(value) | -+----------+--------------------+ -| *Getter* | get_storage() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_storage(value) | ++-----------+--------------------+ +| *Getter* | get_storage() | ++-----------+--------------------+ The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants. diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index f5a36fa98..575ce79b5 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -19,15 +19,15 @@ Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. Properties ---------- -+-------------------------------+-------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`size` | -+-------------------------------+-------------------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_depth` | -+-------------------------------+-------------------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_height` | -+-------------------------------+-------------------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_width` | -+-------------------------------+-------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`size` | Vector3( 2, 2, 2 ) | ++-------------------------------+-------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`subdivide_depth` | 0 | ++-------------------------------+-------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`subdivide_height` | 0 | ++-------------------------------+-------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`subdivide_width` | 0 | ++-------------------------------+-------------------------------------------------------------------+--------------------+ Description ----------- @@ -43,47 +43,55 @@ Property Descriptions - :ref:`Vector3` **size** -+----------+-----------------+ -| *Setter* | set_size(value) | -+----------+-----------------+ -| *Getter* | get_size() | -+----------+-----------------+ ++-----------+--------------------+ +| *Default* | Vector3( 2, 2, 2 ) | ++-----------+--------------------+ +| *Setter* | set_size(value) | ++-----------+--------------------+ +| *Getter* | get_size() | ++-----------+--------------------+ -Size of the cuboid mesh. Defaults to (2, 2, 2). +Size of the cuboid mesh. .. _class_CubeMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** -+----------+----------------------------+ -| *Setter* | set_subdivide_depth(value) | -+----------+----------------------------+ -| *Getter* | get_subdivide_depth() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_subdivide_depth(value) | ++-----------+----------------------------+ +| *Getter* | get_subdivide_depth() | ++-----------+----------------------------+ -Number of extra edge loops inserted along the Z axis. Defaults to 0. +Number of extra edge loops inserted along the Z axis. .. _class_CubeMesh_property_subdivide_height: - :ref:`int` **subdivide_height** -+----------+-----------------------------+ -| *Setter* | set_subdivide_height(value) | -+----------+-----------------------------+ -| *Getter* | get_subdivide_height() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0 | ++-----------+-----------------------------+ +| *Setter* | set_subdivide_height(value) | ++-----------+-----------------------------+ +| *Getter* | get_subdivide_height() | ++-----------+-----------------------------+ -Number of extra edge loops inserted along the Y axis. Defaults to 0. +Number of extra edge loops inserted along the Y axis. .. _class_CubeMesh_property_subdivide_width: - :ref:`int` **subdivide_width** -+----------+----------------------------+ -| *Setter* | set_subdivide_width(value) | -+----------+----------------------------+ -| *Getter* | get_subdivide_width() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_subdivide_width(value) | ++-----------+----------------------------+ +| *Getter* | get_subdivide_width() | ++-----------+----------------------------+ -Number of extra edge loops inserted along the X axis. Defaults to 0. +Number of extra edge loops inserted along the X axis. diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 4ffab0f46..449e99404 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -19,13 +19,13 @@ A mathematic curve. Properties ---------- -+---------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`bake_resolution` | -+---------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`max_value` | -+---------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`min_value` | -+---------------------------+--------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`bake_resolution` | 100 | ++---------------------------+--------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`max_value` | 1.0 | ++---------------------------+--------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`min_value` | 0.0 | ++---------------------------+--------------------------------------------------------------+-----+ Methods ------- @@ -110,11 +110,13 @@ Property Descriptions - :ref:`int` **bake_resolution** -+----------+----------------------------+ -| *Setter* | set_bake_resolution(value) | -+----------+----------------------------+ -| *Getter* | get_bake_resolution() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 100 | ++-----------+----------------------------+ +| *Setter* | set_bake_resolution(value) | ++-----------+----------------------------+ +| *Getter* | get_bake_resolution() | ++-----------+----------------------------+ The number of points to include in the baked (i.e. cached) curve data. @@ -122,25 +124,29 @@ The number of points to include in the baked (i.e. cached) curve data. - :ref:`float` **max_value** -+----------+----------------------+ -| *Setter* | set_max_value(value) | -+----------+----------------------+ -| *Getter* | get_max_value() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1.0 | ++-----------+----------------------+ +| *Setter* | set_max_value(value) | ++-----------+----------------------+ +| *Getter* | get_max_value() | ++-----------+----------------------+ -The maximum value the curve can reach. Default value: ``1``. +The maximum value the curve can reach. .. _class_Curve_property_min_value: - :ref:`float` **min_value** -+----------+----------------------+ -| *Setter* | set_min_value(value) | -+----------+----------------------+ -| *Getter* | get_min_value() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0.0 | ++-----------+----------------------+ +| *Setter* | set_min_value(value) | ++-----------+----------------------+ +| *Getter* | get_min_value() | ++-----------+----------------------+ -The minimum value the curve can reach. Default value: ``0``. +The minimum value the curve can reach. Method Descriptions ------------------- diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 5e357f82f..298f35d40 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -19,9 +19,9 @@ Describes a Bézier curve in 2D space. Properties ---------- -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`bake_interval` | -+---------------------------+------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`bake_interval` | 5.0 | ++---------------------------+------------------------------------------------------------+-----+ Methods ------- @@ -78,11 +78,13 @@ Property Descriptions - :ref:`float` **bake_interval** -+----------+--------------------------+ -| *Setter* | set_bake_interval(value) | -+----------+--------------------------+ -| *Getter* | get_bake_interval() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 5.0 | ++-----------+--------------------------+ +| *Setter* | set_bake_interval(value) | ++-----------+--------------------------+ +| *Getter* | get_bake_interval() | ++-----------+--------------------------+ The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 8e7fe02a4..d8d577940 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -19,11 +19,11 @@ Describes a Bézier curve in 3D space. Properties ---------- -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`bake_interval` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`up_vector_enabled` | -+---------------------------+--------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`bake_interval` | 0.2 | ++---------------------------+--------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`up_vector_enabled` | true | ++---------------------------+--------------------------------------------------------------------+------+ Methods ------- @@ -90,11 +90,13 @@ Property Descriptions - :ref:`float` **bake_interval** -+----------+--------------------------+ -| *Setter* | set_bake_interval(value) | -+----------+--------------------------+ -| *Getter* | get_bake_interval() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.2 | ++-----------+--------------------------+ +| *Setter* | set_bake_interval(value) | ++-----------+--------------------------+ +| *Getter* | get_bake_interval() | ++-----------+--------------------------+ The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. @@ -102,11 +104,13 @@ The distance in meters between two adjacent cached points. Changing it forces th - :ref:`bool` **up_vector_enabled** -+----------+------------------------------+ -| *Setter* | set_up_vector_enabled(value) | -+----------+------------------------------+ -| *Getter* | is_up_vector_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | true | ++-----------+------------------------------+ +| *Setter* | set_up_vector_enabled(value) | ++-----------+------------------------------+ +| *Getter* | is_up_vector_enabled() | ++-----------+------------------------------+ If ``true``, the curve will bake up vectors used for orientation. This is used when :ref:`PathFollow.rotation_mode` is set to :ref:`PathFollow.ROTATION_ORIENTED`. Changing it forces the cache to be recomputed. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 532ae70f7..2c8b300bb 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -19,11 +19,11 @@ A texture that shows a curve. Properties ---------- -+---------------------------+-------------------------------------------------+ -| :ref:`Curve` | :ref:`curve` | -+---------------------------+-------------------------------------------------+ -| :ref:`int` | :ref:`width` | -+---------------------------+-------------------------------------------------+ ++---------------------------+-------------------------------------------------+------+ +| :ref:`Curve` | :ref:`curve` | null | ++---------------------------+-------------------------------------------------+------+ +| :ref:`int` | :ref:`width` | 2048 | ++---------------------------+-------------------------------------------------+------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`Curve` **curve** -+----------+------------------+ -| *Setter* | set_curve(value) | -+----------+------------------+ -| *Getter* | get_curve() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | null | ++-----------+------------------+ +| *Setter* | set_curve(value) | ++-----------+------------------+ +| *Getter* | get_curve() | ++-----------+------------------+ The ``curve`` rendered onto the texture. @@ -49,11 +51,13 @@ The ``curve`` rendered onto the texture. - :ref:`int` **width** -+----------+------------------+ -| *Setter* | set_width(value) | -+----------+------------------+ -| *Getter* | get_width() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 2048 | ++-----------+------------------+ +| *Setter* | set_width(value) | ++-----------+------------------+ +| *Getter* | get_width() | ++-----------+------------------+ The width of the texture. diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 7a169c7c5..49dff046e 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -19,17 +19,17 @@ Class representing a cylindrical :ref:`PrimitiveMesh`. Properties ---------- -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`bottom_radius` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`radial_segments` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`rings` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`top_radius` | -+---------------------------+---------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`bottom_radius` | 1.0 | ++---------------------------+---------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`height` | 2.0 | ++---------------------------+---------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`radial_segments` | 64 | ++---------------------------+---------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`rings` | 4 | ++---------------------------+---------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`top_radius` | 1.0 | ++---------------------------+---------------------------------------------------------------------+-----+ Description ----------- @@ -43,59 +43,69 @@ Property Descriptions - :ref:`float` **bottom_radius** -+----------+--------------------------+ -| *Setter* | set_bottom_radius(value) | -+----------+--------------------------+ -| *Getter* | get_bottom_radius() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_bottom_radius(value) | ++-----------+--------------------------+ +| *Getter* | get_bottom_radius() | ++-----------+--------------------------+ -Bottom radius of the cylinder. Defaults to 1.0. +Bottom radius of the cylinder. .. _class_CylinderMesh_property_height: - :ref:`float` **height** -+----------+-------------------+ -| *Setter* | set_height(value) | -+----------+-------------------+ -| *Getter* | get_height() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 2.0 | ++-----------+-------------------+ +| *Setter* | set_height(value) | ++-----------+-------------------+ +| *Getter* | get_height() | ++-----------+-------------------+ -Full height of the cylinder. Defaults to 2.0. +Full height of the cylinder. .. _class_CylinderMesh_property_radial_segments: - :ref:`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 cylinder. Defaults to 64. +Number of radial segments on the cylinder. .. _class_CylinderMesh_property_rings: - :ref:`int` **rings** -+----------+------------------+ -| *Setter* | set_rings(value) | -+----------+------------------+ -| *Getter* | get_rings() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 4 | ++-----------+------------------+ +| *Setter* | set_rings(value) | ++-----------+------------------+ +| *Getter* | get_rings() | ++-----------+------------------+ -Number of edge rings along the height of the cylinder. Defaults to 4. +Number of edge rings along the height of the cylinder. .. _class_CylinderMesh_property_top_radius: - :ref:`float` **top_radius** -+----------+-----------------------+ -| *Setter* | set_top_radius(value) | -+----------+-----------------------+ -| *Getter* | get_top_radius() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_top_radius(value) | ++-----------+-----------------------+ +| *Getter* | get_top_radius() | ++-----------+-----------------------+ -Top radius of the cylinder. Defaults to 1.0. +Top radius of the cylinder. diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst index 695b48a08..daa2b7bec 100644 --- a/classes/class_cylindershape.rst +++ b/classes/class_cylindershape.rst @@ -19,11 +19,11 @@ Cylinder shape for collisions. Properties ---------- -+---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+----------------------------------------------------+ ++---------------------------+----------------------------------------------------+-----+ +| :ref:`float` | :ref:`height` | 2.0 | ++---------------------------+----------------------------------------------------+-----+ +| :ref:`float` | :ref:`radius` | 1.0 | ++---------------------------+----------------------------------------------------+-----+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`float` **height** -+----------+-------------------+ -| *Setter* | set_height(value) | -+----------+-------------------+ -| *Getter* | get_height() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 2.0 | ++-----------+-------------------+ +| *Setter* | set_height(value) | ++-----------+-------------------+ +| *Getter* | get_height() | ++-----------+-------------------+ The cylinder's height. @@ -49,11 +51,13 @@ The cylinder's height. - :ref:`float` **radius** -+----------+-------------------+ -| *Setter* | set_radius(value) | -+----------+-------------------+ -| *Getter* | get_radius() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ The cylinder's radius. diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 1121503d6..34e25895e 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -19,15 +19,15 @@ Damped spring constraint for 2D physics. Properties ---------- -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`rest_length` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`stiffness` | -+---------------------------+--------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`damping` | 1.0 | ++---------------------------+--------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`length` | 50.0 | ++---------------------------+--------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`rest_length` | 0.0 | ++---------------------------+--------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`stiffness` | 20.0 | ++---------------------------+--------------------------------------------------------------------+------+ Description ----------- @@ -41,47 +41,55 @@ Property Descriptions - :ref:`float` **damping** -+----------+--------------------+ -| *Setter* | set_damping(value) | -+----------+--------------------+ -| *Getter* | get_damping() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1.0 | ++-----------+--------------------+ +| *Setter* | set_damping(value) | ++-----------+--------------------+ +| *Getter* | get_damping() | ++-----------+--------------------+ -The spring joint's damping ratio. A value between ``0`` and ``1``. When the two bodies move into different directions the system tries to align them to the spring axis again. A high ``damping`` value forces the attached bodies to align faster. Default value: ``1``. +The spring joint's damping ratio. A value between ``0`` and ``1``. When the two bodies move into different directions the system tries to align them to the spring axis again. A high ``damping`` value forces the attached bodies to align faster. .. _class_DampedSpringJoint2D_property_length: - :ref:`float` **length** -+----------+-------------------+ -| *Setter* | set_length(value) | -+----------+-------------------+ -| *Getter* | get_length() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 50.0 | ++-----------+-------------------+ +| *Setter* | set_length(value) | ++-----------+-------------------+ +| *Getter* | get_length() | ++-----------+-------------------+ -The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: ``50``. +The spring joint's maximum length. The two attached bodies cannot stretch it past this value. .. _class_DampedSpringJoint2D_property_rest_length: - :ref:`float` **rest_length** -+----------+------------------------+ -| *Setter* | set_rest_length(value) | -+----------+------------------------+ -| *Getter* | get_rest_length() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_rest_length(value) | ++-----------+------------------------+ +| *Getter* | get_rest_length() | ++-----------+------------------------+ -When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: ``0``. +When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. .. _class_DampedSpringJoint2D_property_stiffness: - :ref:`float` **stiffness** -+----------+----------------------+ -| *Setter* | set_stiffness(value) | -+----------+----------------------+ -| *Getter* | get_stiffness() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 20.0 | ++-----------+----------------------+ +| *Setter* | set_stiffness(value) | ++-----------+----------------------+ +| *Getter* | get_stiffness() | ++-----------+----------------------+ -The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: ``20``. +The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 8735037ea..b71f233cb 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -19,25 +19,25 @@ Directional light from a distance, as from the Sun. Properties ---------- -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_bias_split_scale` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`directional_shadow_blend_splits` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`ShadowDepthRange` | :ref:`directional_shadow_depth_range` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_max_distance` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`ShadowMode` | :ref:`directional_shadow_mode` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_normal_bias` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_split_1` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_split_2` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_split_3` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`directional_shadow_bias_split_scale` | 0.25 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`directional_shadow_blend_splits` | false | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`ShadowDepthRange` | :ref:`directional_shadow_depth_range` | 0 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`directional_shadow_max_distance` | 200.0 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`ShadowMode` | :ref:`directional_shadow_mode` | 2 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`directional_shadow_normal_bias` | 0.8 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`directional_shadow_split_1` | 0.1 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`directional_shadow_split_2` | 0.2 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`directional_shadow_split_3` | 0.5 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-------+ Enumerations ------------ @@ -66,7 +66,7 @@ enum **ShadowMode**: enum **ShadowDepthRange**: -- **SHADOW_DEPTH_RANGE_STABLE** = **0** --- Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. +- **SHADOW_DEPTH_RANGE_STABLE** = **0** --- Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. - **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. @@ -87,11 +87,13 @@ Property Descriptions - :ref:`float` **directional_shadow_bias_split_scale** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.25 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Amount of extra bias for shadow splits that are far away. If self-shadowing occurs only on the splits far away, increasing this value can fix them. @@ -99,23 +101,27 @@ Amount of extra bias for shadow splits that are far away. If self-shadowing occu - :ref:`bool` **directional_shadow_blend_splits** -+----------+---------------------------+ -| *Setter* | set_blend_splits(value) | -+----------+---------------------------+ -| *Getter* | is_blend_splits_enabled() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_blend_splits(value) | ++-----------+---------------------------+ +| *Getter* | is_blend_splits_enabled() | ++-----------+---------------------------+ -If ``true``, shadow detail is sacrificed in exchange for smoother transitions between splits. Default value: ``false``. +If ``true``, shadow detail is sacrificed in exchange for smoother transitions between splits. .. _class_DirectionalLight_property_directional_shadow_depth_range: - :ref:`ShadowDepthRange` **directional_shadow_depth_range** -+----------+-------------------------------+ -| *Setter* | set_shadow_depth_range(value) | -+----------+-------------------------------+ -| *Getter* | get_shadow_depth_range() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0 | ++-----------+-------------------------------+ +| *Setter* | set_shadow_depth_range(value) | ++-----------+-------------------------------+ +| *Getter* | get_shadow_depth_range() | ++-----------+-------------------------------+ Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. @@ -123,11 +129,13 @@ Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRang - :ref:`float` **directional_shadow_max_distance** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 200.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The maximum distance for shadow splits. @@ -135,11 +143,13 @@ The maximum distance for shadow splits. - :ref:`ShadowMode` **directional_shadow_mode** -+----------+------------------------+ -| *Setter* | set_shadow_mode(value) | -+----------+------------------------+ -| *Getter* | get_shadow_mode() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 2 | ++-----------+------------------------+ +| *Setter* | set_shadow_mode(value) | ++-----------+------------------------+ +| *Getter* | get_shadow_mode() | ++-----------+------------------------+ The light's shadow rendering algorithm. See :ref:`ShadowMode`. @@ -147,11 +157,13 @@ The light's shadow rendering algorithm. See :ref:`ShadowMode` **directional_shadow_normal_bias** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.8 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Can be used to fix special cases of self shadowing when objects are perpendicular to the light. @@ -159,11 +171,13 @@ Can be used to fix special cases of self shadowing when objects are perpendicula - :ref:`float` **directional_shadow_split_1** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.1 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is ``SHADOW_PARALLEL_2_SPLITS`` or ``SHADOW_PARALLEL_4_SPLITS``. @@ -171,11 +185,13 @@ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow - :ref:`float` **directional_shadow_split_2** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.2 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is ``SHADOW_PARALLEL_2_SPLITS`` or ``SHADOW_PARALLEL_4_SPLITS``. @@ -183,11 +199,13 @@ The distance from shadow split 1 to split 2. Relative to :ref:`directional_shado - :ref:`float` **directional_shadow_split_3** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.5 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is ``SHADOW_PARALLEL_4_SPLITS``. diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index 20d195f83..36978c291 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -19,27 +19,27 @@ DynamicFont renders vector font files at runtime. Properties ---------- -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`extra_spacing_bottom` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`extra_spacing_char` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`extra_spacing_space` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`extra_spacing_top` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`DynamicFontData` | :ref:`font_data` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`outline_color` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`outline_size` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_filter` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_mipmaps` | -+-----------------------------------------------+------------------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`extra_spacing_bottom` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`extra_spacing_char` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`extra_spacing_space` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`extra_spacing_top` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`DynamicFontData` | :ref:`font_data` | null | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`outline_color` | Color( 1, 1, 1, 1 ) | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`outline_size` | 0 | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`size` | 16 | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`use_filter` | false | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`use_mipmaps` | false | ++-----------------------------------------------+------------------------------------------------------------------------------+---------------------+ Methods ------- @@ -98,11 +98,13 @@ Property Descriptions - :ref:`int` **extra_spacing_bottom** -+----------+--------------------+ -| *Setter* | set_spacing(value) | -+----------+--------------------+ -| *Getter* | get_spacing() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_spacing(value) | ++-----------+--------------------+ +| *Getter* | get_spacing() | ++-----------+--------------------+ Extra spacing at the bottom in pixels. @@ -110,11 +112,13 @@ Extra spacing at the bottom in pixels. - :ref:`int` **extra_spacing_char** -+----------+--------------------+ -| *Setter* | set_spacing(value) | -+----------+--------------------+ -| *Getter* | get_spacing() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_spacing(value) | ++-----------+--------------------+ +| *Getter* | get_spacing() | ++-----------+--------------------+ Extra character spacing in pixels. @@ -122,11 +126,13 @@ Extra character spacing in pixels. - :ref:`int` **extra_spacing_space** -+----------+--------------------+ -| *Setter* | set_spacing(value) | -+----------+--------------------+ -| *Getter* | get_spacing() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_spacing(value) | ++-----------+--------------------+ +| *Getter* | get_spacing() | ++-----------+--------------------+ Extra space spacing in pixels. @@ -134,11 +140,13 @@ Extra space spacing in pixels. - :ref:`int` **extra_spacing_top** -+----------+--------------------+ -| *Setter* | set_spacing(value) | -+----------+--------------------+ -| *Getter* | get_spacing() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_spacing(value) | ++-----------+--------------------+ +| *Getter* | get_spacing() | ++-----------+--------------------+ Extra spacing at the top in pixels. @@ -146,11 +154,13 @@ Extra spacing at the top in pixels. - :ref:`DynamicFontData` **font_data** -+----------+----------------------+ -| *Setter* | set_font_data(value) | -+----------+----------------------+ -| *Getter* | get_font_data() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | null | ++-----------+----------------------+ +| *Setter* | set_font_data(value) | ++-----------+----------------------+ +| *Getter* | get_font_data() | ++-----------+----------------------+ The font data. @@ -158,31 +168,37 @@ The font data. - :ref:`Color` **outline_color** -+----------+--------------------------+ -| *Setter* | set_outline_color(value) | -+----------+--------------------------+ -| *Getter* | get_outline_color() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+--------------------------+ +| *Setter* | set_outline_color(value) | ++-----------+--------------------------+ +| *Getter* | get_outline_color() | ++-----------+--------------------------+ .. _class_DynamicFont_property_outline_size: - :ref:`int` **outline_size** -+----------+-------------------------+ -| *Setter* | set_outline_size(value) | -+----------+-------------------------+ -| *Getter* | get_outline_size() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_outline_size(value) | ++-----------+-------------------------+ +| *Getter* | get_outline_size() | ++-----------+-------------------------+ .. _class_DynamicFont_property_size: - :ref:`int` **size** -+----------+-----------------+ -| *Setter* | set_size(value) | -+----------+-----------------+ -| *Getter* | get_size() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 16 | ++-----------+-----------------+ +| *Setter* | set_size(value) | ++-----------+-----------------+ +| *Getter* | get_size() | ++-----------+-----------------+ The font size. @@ -190,11 +206,13 @@ The font size. - :ref:`bool` **use_filter** -+----------+-----------------------+ -| *Setter* | set_use_filter(value) | -+----------+-----------------------+ -| *Getter* | get_use_filter() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | false | ++-----------+-----------------------+ +| *Setter* | set_use_filter(value) | ++-----------+-----------------------+ +| *Getter* | get_use_filter() | ++-----------+-----------------------+ If ``true``, filtering is used. @@ -202,11 +220,13 @@ If ``true``, filtering is used. - :ref:`bool` **use_mipmaps** -+----------+------------------------+ -| *Setter* | set_use_mipmaps(value) | -+----------+------------------------+ -| *Getter* | get_use_mipmaps() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_use_mipmaps(value) | ++-----------+------------------------+ +| *Getter* | get_use_mipmaps() | ++-----------+------------------------+ If ``true``, mipmapping is used. diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index 4f6f38c5a..e6f91ff07 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -19,13 +19,13 @@ Used with :ref:`DynamicFont` to describe the location of a fo Properties ---------- -+----------------------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`antialiased` | -+----------------------------------------------+----------------------------------------------------------------+ -| :ref:`String` | :ref:`font_path` | -+----------------------------------------------+----------------------------------------------------------------+ -| :ref:`Hinting` | :ref:`hinting` | -+----------------------------------------------+----------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`antialiased` | true | ++----------------------------------------------+----------------------------------------------------------------+------+ +| :ref:`String` | :ref:`font_path` | "" | ++----------------------------------------------+----------------------------------------------------------------+------+ +| :ref:`Hinting` | :ref:`hinting` | 2 | ++----------------------------------------------+----------------------------------------------------------------+------+ Enumerations ------------ @@ -58,11 +58,13 @@ Property Descriptions - :ref:`bool` **antialiased** -+----------+------------------------+ -| *Setter* | set_antialiased(value) | -+----------+------------------------+ -| *Getter* | is_antialiased() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | true | ++-----------+------------------------+ +| *Setter* | set_antialiased(value) | ++-----------+------------------------+ +| *Getter* | is_antialiased() | ++-----------+------------------------+ Controls whether the font should be rendered with anti-aliasing. @@ -70,11 +72,13 @@ Controls whether the font should be rendered with anti-aliasing. - :ref:`String` **font_path** -+----------+----------------------+ -| *Setter* | set_font_path(value) | -+----------+----------------------+ -| *Getter* | get_font_path() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "" | ++-----------+----------------------+ +| *Setter* | set_font_path(value) | ++-----------+----------------------+ +| *Getter* | get_font_path() | ++-----------+----------------------+ The path to the vector font file. @@ -82,11 +86,13 @@ The path to the vector font file. - :ref:`Hinting` **hinting** -+----------+--------------------+ -| *Setter* | set_hinting(value) | -+----------+--------------------+ -| *Getter* | get_hinting() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 2 | ++-----------+--------------------+ +| *Setter* | set_hinting(value) | ++-----------+--------------------+ +| *Getter* | get_hinting() | ++-----------+--------------------+ The font hinting mode used by FreeType. diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 29874f9ab..e8664e665 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -19,23 +19,23 @@ Brief Description Properties ---------- -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Access` | :ref:`access` | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_dir` | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_file` | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_path` | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disable_overwrite_warning` | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`DisplayMode` | :ref:`display_mode` | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_hidden_files` | -+-------------------------------------------------------+---------------------------------------------------------------------------------------------+ ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ +| :ref:`Access` | :ref:`access` | 0 | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`current_dir` | "res://" | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`current_file` | "" | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`current_path` | "res://" | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`disable_overwrite_warning` | false | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ +| :ref:`DisplayMode` | :ref:`display_mode` | 0 | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ +| :ref:`Mode` | :ref:`mode` | 4 | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`show_hidden_files` | false | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+----------+ Methods ------- @@ -133,11 +133,13 @@ Property Descriptions - :ref:`Access` **access** -+----------+-------------------+ -| *Setter* | set_access(value) | -+----------+-------------------+ -| *Getter* | get_access() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0 | ++-----------+-------------------+ +| *Setter* | set_access(value) | ++-----------+-------------------+ +| *Getter* | get_access() | ++-----------+-------------------+ The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. @@ -145,11 +147,13 @@ The location from which the user may select a file, including ``res://``, ``user - :ref:`String` **current_dir** -+----------+------------------------+ -| *Setter* | set_current_dir(value) | -+----------+------------------------+ -| *Getter* | get_current_dir() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | "res://" | ++-----------+------------------------+ +| *Setter* | set_current_dir(value) | ++-----------+------------------------+ +| *Getter* | get_current_dir() | ++-----------+------------------------+ The currently occupied directory. @@ -157,11 +161,13 @@ The currently occupied directory. - :ref:`String` **current_file** -+----------+-------------------------+ -| *Setter* | set_current_file(value) | -+----------+-------------------------+ -| *Getter* | get_current_file() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | "" | ++-----------+-------------------------+ +| *Setter* | set_current_file(value) | ++-----------+-------------------------+ +| *Getter* | get_current_file() | ++-----------+-------------------------+ The currently selected file. @@ -169,11 +175,13 @@ The currently selected file. - :ref:`String` **current_path** -+----------+-------------------------+ -| *Setter* | set_current_path(value) | -+----------+-------------------------+ -| *Getter* | get_current_path() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | "res://" | ++-----------+-------------------------+ +| *Setter* | set_current_path(value) | ++-----------+-------------------------+ +| *Getter* | get_current_path() | ++-----------+-------------------------+ The file system path in the address bar. @@ -181,11 +189,13 @@ The file system path in the address bar. - :ref:`bool` **disable_overwrite_warning** -+----------+--------------------------------------+ -| *Setter* | set_disable_overwrite_warning(value) | -+----------+--------------------------------------+ -| *Getter* | is_overwrite_warning_disabled() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | false | ++-----------+--------------------------------------+ +| *Setter* | set_disable_overwrite_warning(value) | ++-----------+--------------------------------------+ +| *Getter* | is_overwrite_warning_disabled() | ++-----------+--------------------------------------+ If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting files. @@ -193,11 +203,13 @@ If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting - :ref:`DisplayMode` **display_mode** -+----------+-------------------------+ -| *Setter* | set_display_mode(value) | -+----------+-------------------------+ -| *Getter* | get_display_mode() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_display_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_display_mode() | ++-----------+-------------------------+ The view format in which the ``EditorFileDialog`` displays resources to the user. @@ -205,11 +217,13 @@ The view format in which the ``EditorFileDialog`` displays resources to the user - :ref:`Mode` **mode** -+----------+-----------------+ -| *Setter* | set_mode(value) | -+----------+-----------------+ -| *Getter* | get_mode() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 4 | ++-----------+-----------------+ +| *Setter* | set_mode(value) | ++-----------+-----------------+ +| *Getter* | get_mode() | ++-----------+-----------------+ The purpose of the ``EditorFileDialog``, which defines the allowed behaviors. @@ -217,11 +231,13 @@ The purpose of the ``EditorFileDialog``, which defines the allowed behaviors. - :ref:`bool` **show_hidden_files** -+----------+------------------------------+ -| *Setter* | set_show_hidden_files(value) | -+----------+------------------------------+ -| *Getter* | is_showing_hidden_files() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_show_hidden_files(value) | ++-----------+------------------------------+ +| *Getter* | is_showing_hidden_files() | ++-----------+------------------------------+ If ``true``, hidden files and directories will be visible in the ``EditorFileDialog``. diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 415af889e..83cd8eb38 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -141,7 +141,7 @@ Gets the name of the options preset at this index. - :ref:`float` **get_priority** **(** **)** virtual -Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. +Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is ``1.0``. .. _class_EditorImportPlugin_method_get_recognized_extensions: diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index c33eb8447..e7039759a 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -19,19 +19,19 @@ Custom control to edit properties for adding into the inspector. Properties ---------- -+-----------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`checkable` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`checked` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_red` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`keying` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`label` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`read_only` | -+-----------------------------+-----------------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`checkable` | false | ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`checked` | false | ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`draw_red` | false | ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`keying` | false | ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`String` | :ref:`label` | "" | ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`read_only` | false | ++-----------------------------+-----------------------------------------------------------+-------+ Methods ------- @@ -115,11 +115,13 @@ Property Descriptions - :ref:`bool` **checkable** -+----------+----------------------+ -| *Setter* | set_checkable(value) | -+----------+----------------------+ -| *Getter* | is_checkable() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_checkable(value) | ++-----------+----------------------+ +| *Getter* | is_checkable() | ++-----------+----------------------+ Used by the inspector, set when property is checkable. @@ -127,11 +129,13 @@ Used by the inspector, set when property is checkable. - :ref:`bool` **checked** -+----------+--------------------+ -| *Setter* | set_checked(value) | -+----------+--------------------+ -| *Getter* | is_checked() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_checked(value) | ++-----------+--------------------+ +| *Getter* | is_checked() | ++-----------+--------------------+ Used by the inspector, when the property is checked. @@ -139,11 +143,13 @@ Used by the inspector, when the property is checked. - :ref:`bool` **draw_red** -+----------+---------------------+ -| *Setter* | set_draw_red(value) | -+----------+---------------------+ -| *Getter* | is_draw_red() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_draw_red(value) | ++-----------+---------------------+ +| *Getter* | is_draw_red() | ++-----------+---------------------+ Used by the inspector, when the property must draw with error color. @@ -151,11 +157,13 @@ Used by the inspector, when the property must draw with error color. - :ref:`bool` **keying** -+----------+-------------------+ -| *Setter* | set_keying(value) | -+----------+-------------------+ -| *Getter* | is_keying() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_keying(value) | ++-----------+-------------------+ +| *Getter* | is_keying() | ++-----------+-------------------+ Used by the inspector, when the property can add keys for animation. @@ -163,11 +171,13 @@ Used by the inspector, when the property can add keys for animation. - :ref:`String` **label** -+----------+------------------+ -| *Setter* | set_label(value) | -+----------+------------------+ -| *Getter* | get_label() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | "" | ++-----------+------------------+ +| *Setter* | set_label(value) | ++-----------+------------------+ +| *Getter* | get_label() | ++-----------+------------------+ Sets this property to change the label (if you want to show one). @@ -175,11 +185,13 @@ Sets this property to change the label (if you want to show one). - :ref:`bool` **read_only** -+----------+----------------------+ -| *Setter* | set_read_only(value) | -+----------+----------------------+ -| *Getter* | is_read_only() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_read_only(value) | ++-----------+----------------------+ +| *Getter* | is_read_only() | ++-----------+----------------------+ Used by the inspector, when the property is read-only. diff --git a/classes/class_editorspatialgizmoplugin.rst b/classes/class_editorspatialgizmoplugin.rst index ebb525a6d..300d34383 100644 --- a/classes/class_editorspatialgizmoplugin.rst +++ b/classes/class_editorspatialgizmoplugin.rst @@ -78,7 +78,7 @@ Adds a new material to the internal material list for the plugin. It can then be - :ref:`bool` **can_be_hidden** **(** **)** virtual -Override this method to define whether the gizmo can be hidden or not. Defaults to ``true``. +Override this method to define whether the gizmo can be hidden or not. Returns ``true`` if not overridden. .. _class_EditorSpatialGizmoPlugin_method_commit_handle: diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index 0a98a3596..b7b5df5c4 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -19,9 +19,9 @@ Holds a reference to an :ref:`Object`'s instance ID. Properties ---------- -+-----------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`object_id` | -+-----------------------+--------------------------------------------------------------+ ++-----------------------+--------------------------------------------------------------+---+ +| :ref:`int` | :ref:`object_id` | 0 | ++-----------------------+--------------------------------------------------------------+---+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`int` **object_id** -+----------+----------------------+ -| *Setter* | set_object_id(value) | -+----------+----------------------+ -| *Getter* | get_object_id() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_object_id(value) | ++-----------+----------------------+ +| *Getter* | get_object_id() | ++-----------+----------------------+ The :ref:`Object` identifier stored in this ``EncodedObjectAsID`` instance. The object instance can be retrieved with :ref:`@GDScript.instance_from_id`. diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 89b8d176b..5f46db3be 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -19,17 +19,17 @@ Access to basic engine properties. Properties ---------- -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_hint` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`iterations_per_second` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics_jitter_fix` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`target_fps` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`time_scale` | -+---------------------------+---------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`editor_hint` | true | ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`iterations_per_second` | 60 | ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`physics_jitter_fix` | 0.5 | ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`target_fps` | 0 | ++---------------------------+---------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`time_scale` | 1.0 | ++---------------------------+---------------------------------------------------------------------------+------+ Methods ------- @@ -72,11 +72,13 @@ Property Descriptions - :ref:`bool` **editor_hint** -+----------+------------------------+ -| *Setter* | set_editor_hint(value) | -+----------+------------------------+ -| *Getter* | is_editor_hint() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | true | ++-----------+------------------------+ +| *Setter* | set_editor_hint(value) | ++-----------+------------------------+ +| *Getter* | is_editor_hint() | ++-----------+------------------------+ If ``true``, it is running inside the editor. Useful for tool scripts. @@ -84,11 +86,13 @@ If ``true``, it is running inside the editor. Useful for tool scripts. - :ref:`int` **iterations_per_second** -+----------+----------------------------------+ -| *Setter* | set_iterations_per_second(value) | -+----------+----------------------------------+ -| *Getter* | get_iterations_per_second() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 60 | ++-----------+----------------------------------+ +| *Setter* | set_iterations_per_second(value) | ++-----------+----------------------------------+ +| *Getter* | get_iterations_per_second() | ++-----------+----------------------------------+ The number of fixed iterations per second (for fixed process and physics). @@ -96,33 +100,39 @@ The number of fixed iterations per second (for fixed process and physics). - :ref:`float` **physics_jitter_fix** -+----------+-------------------------------+ -| *Setter* | set_physics_jitter_fix(value) | -+----------+-------------------------------+ -| *Getter* | get_physics_jitter_fix() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.5 | ++-----------+-------------------------------+ +| *Setter* | set_physics_jitter_fix(value) | ++-----------+-------------------------------+ +| *Getter* | get_physics_jitter_fix() | ++-----------+-------------------------------+ .. _class_Engine_property_target_fps: - :ref:`int` **target_fps** -+----------+-----------------------+ -| *Setter* | set_target_fps(value) | -+----------+-----------------------+ -| *Getter* | get_target_fps() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_target_fps(value) | ++-----------+-----------------------+ +| *Getter* | get_target_fps() | ++-----------+-----------------------+ -The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit. +The desired frames per second. If the hardware cannot keep up, this setting may not be respected. A value of 0 means no limit. .. _class_Engine_property_time_scale: - :ref:`float` **time_scale** -+----------+-----------------------+ -| *Setter* | set_time_scale(value) | -+----------+-----------------------+ -| *Getter* | get_time_scale() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_time_scale(value) | ++-----------+-----------------------+ +| *Getter* | get_time_scale() | ++-----------+-----------------------+ Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 4aa3f6d0d..088b0463e 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -19,175 +19,175 @@ Resource for environment nodes (like :ref:`WorldEnvironment` | :ref:`adjustment_brightness` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`adjustment_color_correction` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`adjustment_contrast` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`adjustment_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`adjustment_saturation` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ambient_light_color` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ambient_light_energy` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ambient_light_sky_contribution` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_exposure_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_max_luma` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_min_luma` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_scale` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_speed` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`background_camera_feed_id` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`background_canvas_max_layer` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`background_color` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`background_energy` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`BGMode` | :ref:`background_mode` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Sky` | :ref:`background_sky` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`background_sky_custom_fov` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`background_sky_orientation` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`background_sky_rotation` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`background_sky_rotation_degrees` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_amount` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_distance` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dof_blur_far_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`DOFBlurQuality` | :ref:`dof_blur_far_quality` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_transition` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_amount` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_distance` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dof_blur_near_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`DOFBlurQuality` | :ref:`dof_blur_near_quality` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_transition` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`fog_color` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_begin` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_curve` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_depth_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_end` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_curve` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_height_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_max` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_min` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_sun_amount` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`fog_sun_color` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_transmit_curve` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_transmit_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_bicubic_upscale` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_bloom` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_luminance_cap` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_scale` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_threshold` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_intensity` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/1` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/2` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/3` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/4` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/5` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/6` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/7` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_strength` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_depth_tolerance` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ss_reflections_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_fade_in` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_fade_out` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`ss_reflections_max_steps` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ss_reflections_roughness` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_ao_channel_affect` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_bias` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`SSAOBlur` | :ref:`ssao_blur` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ssao_color` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_edge_sharpness` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ssao_enabled` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_intensity` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_intensity2` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_light_affect` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`SSAOQuality` | :ref:`ssao_quality` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_radius` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_radius2` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tonemap_exposure` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`ToneMapper` | :ref:`tonemap_mode` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tonemap_white` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`adjustment_brightness` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Texture` | :ref:`adjustment_color_correction` | null | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`adjustment_contrast` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`adjustment_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`adjustment_saturation` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Color` | :ref:`ambient_light_color` | Color( 0, 0, 0, 1 ) | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ambient_light_energy` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ambient_light_sky_contribution` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`auto_exposure_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_max_luma` | 8.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_min_luma` | 0.05 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_scale` | 0.4 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_speed` | 0.5 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`int` | :ref:`background_camera_feed_id` | 1 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`int` | :ref:`background_canvas_max_layer` | 0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Color` | :ref:`background_color` | Color( 0, 0, 0, 1 ) | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`background_energy` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`BGMode` | :ref:`background_mode` | 0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Sky` | :ref:`background_sky` | null | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`background_sky_custom_fov` | 0.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Basis` | :ref:`background_sky_orientation` | Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 ) | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Vector3` | :ref:`background_sky_rotation` | Vector3( 0, 0, 0 ) | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Vector3` | :ref:`background_sky_rotation_degrees` | Vector3( 0, 0, 0 ) | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_amount` | 0.1 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_distance` | 10.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`dof_blur_far_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`DOFBlurQuality` | :ref:`dof_blur_far_quality` | 1 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_transition` | 5.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_amount` | 0.1 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_distance` | 2.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`dof_blur_near_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`DOFBlurQuality` | :ref:`dof_blur_near_quality` | 1 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_transition` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Color` | :ref:`fog_color` | Color( 0.5, 0.6, 0.7, 1 ) | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`fog_depth_begin` | 10.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`fog_depth_curve` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`fog_depth_enabled` | true | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`fog_depth_end` | 0.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`fog_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`fog_height_curve` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`fog_height_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`fog_height_max` | 100.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`fog_height_min` | 0.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`fog_sun_amount` | 0.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Color` | :ref:`fog_sun_color` | Color( 1, 0.9, 0.7, 1 ) | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`fog_transmit_curve` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`fog_transmit_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_bicubic_upscale` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | 2 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`glow_bloom` | 0.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_luminance_cap` | 12.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_scale` | 2.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_threshold` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`glow_intensity` | 0.8 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/1` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/2` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/3` | true | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/4` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/5` | true | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/6` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/7` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`glow_strength` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_depth_tolerance` | 0.2 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`ss_reflections_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_fade_in` | 0.15 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_fade_out` | 2.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`int` | :ref:`ss_reflections_max_steps` | 64 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`ss_reflections_roughness` | true | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ssao_ao_channel_affect` | 0.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ssao_bias` | 0.01 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`SSAOBlur` | :ref:`ssao_blur` | 3 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`Color` | :ref:`ssao_color` | Color( 0, 0, 0, 1 ) | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ssao_edge_sharpness` | 4.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`bool` | :ref:`ssao_enabled` | false | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ssao_intensity` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ssao_intensity2` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ssao_light_affect` | 0.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`SSAOQuality` | :ref:`ssao_quality` | 1 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ssao_radius` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`ssao_radius2` | 0.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`tonemap_exposure` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`ToneMapper` | :ref:`tonemap_mode` | 0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ +| :ref:`float` | :ref:`tonemap_white` | 1.0 | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+------------------------------------+ Enumerations ------------ @@ -347,11 +347,13 @@ Property Descriptions - :ref:`float` **adjustment_brightness** -+----------+----------------------------------+ -| *Setter* | set_adjustment_brightness(value) | -+----------+----------------------------------+ -| *Getter* | get_adjustment_brightness() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 1.0 | ++-----------+----------------------------------+ +| *Setter* | set_adjustment_brightness(value) | ++-----------+----------------------------------+ +| *Getter* | get_adjustment_brightness() | ++-----------+----------------------------------+ Global brightness value of the rendered scene (default value is 1). @@ -359,11 +361,13 @@ Global brightness value of the rendered scene (default value is 1). - :ref:`Texture` **adjustment_color_correction** -+----------+----------------------------------------+ -| *Setter* | set_adjustment_color_correction(value) | -+----------+----------------------------------------+ -| *Getter* | get_adjustment_color_correction() | -+----------+----------------------------------------+ ++-----------+----------------------------------------+ +| *Default* | null | ++-----------+----------------------------------------+ +| *Setter* | set_adjustment_color_correction(value) | ++-----------+----------------------------------------+ +| *Getter* | get_adjustment_color_correction() | ++-----------+----------------------------------------+ Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. @@ -371,11 +375,13 @@ Applies the provided :ref:`Texture` resource to affect the global - :ref:`float` **adjustment_contrast** -+----------+--------------------------------+ -| *Setter* | set_adjustment_contrast(value) | -+----------+--------------------------------+ -| *Getter* | get_adjustment_contrast() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------------+ +| *Setter* | set_adjustment_contrast(value) | ++-----------+--------------------------------+ +| *Getter* | get_adjustment_contrast() | ++-----------+--------------------------------+ Global contrast value of the rendered scene (default value is 1). @@ -383,11 +389,13 @@ Global contrast value of the rendered scene (default value is 1). - :ref:`bool` **adjustment_enabled** -+----------+------------------------------+ -| *Setter* | set_adjustment_enable(value) | -+----------+------------------------------+ -| *Getter* | is_adjustment_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_adjustment_enable(value) | ++-----------+------------------------------+ +| *Getter* | is_adjustment_enabled() | ++-----------+------------------------------+ Enables the adjustment\_\* options provided by this resource. If ``false``, adjustments modifications will have no effect on the rendered scene. @@ -395,11 +403,13 @@ Enables the adjustment\_\* options provided by this resource. If ``false``, adju - :ref:`float` **adjustment_saturation** -+----------+----------------------------------+ -| *Setter* | set_adjustment_saturation(value) | -+----------+----------------------------------+ -| *Getter* | get_adjustment_saturation() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 1.0 | ++-----------+----------------------------------+ +| *Setter* | set_adjustment_saturation(value) | ++-----------+----------------------------------+ +| *Getter* | get_adjustment_saturation() | ++-----------+----------------------------------+ Global color saturation value of the rendered scene (default value is 1). @@ -407,11 +417,13 @@ Global color saturation value of the rendered scene (default value is 1). - :ref:`Color` **ambient_light_color** -+----------+--------------------------------+ -| *Setter* | set_ambient_light_color(value) | -+----------+--------------------------------+ -| *Getter* | get_ambient_light_color() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | Color( 0, 0, 0, 1 ) | ++-----------+--------------------------------+ +| *Setter* | set_ambient_light_color(value) | ++-----------+--------------------------------+ +| *Getter* | get_ambient_light_color() | ++-----------+--------------------------------+ :ref:`Color` of the ambient light. @@ -419,11 +431,13 @@ Global color saturation value of the rendered scene (default value is 1). - :ref:`float` **ambient_light_energy** -+----------+---------------------------------+ -| *Setter* | set_ambient_light_energy(value) | -+----------+---------------------------------+ -| *Getter* | get_ambient_light_energy() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 1.0 | ++-----------+---------------------------------+ +| *Setter* | set_ambient_light_energy(value) | ++-----------+---------------------------------+ +| *Getter* | get_ambient_light_energy() | ++-----------+---------------------------------+ Energy of the ambient light. The higher the value, the stronger the light. @@ -431,11 +445,13 @@ Energy of the ambient light. The higher the value, the stronger the light. - :ref:`float` **ambient_light_sky_contribution** -+----------+-------------------------------------------+ -| *Setter* | set_ambient_light_sky_contribution(value) | -+----------+-------------------------------------------+ -| *Getter* | get_ambient_light_sky_contribution() | -+----------+-------------------------------------------+ ++-----------+-------------------------------------------+ +| *Default* | 1.0 | ++-----------+-------------------------------------------+ +| *Setter* | set_ambient_light_sky_contribution(value) | ++-----------+-------------------------------------------+ +| *Getter* | get_ambient_light_sky_contribution() | ++-----------+-------------------------------------------+ Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. @@ -443,11 +459,13 @@ Defines the amount of light that the sky brings on the scene. A value of 0 means - :ref:`bool` **auto_exposure_enabled** -+----------+----------------------------------+ -| *Setter* | set_tonemap_auto_exposure(value) | -+----------+----------------------------------+ -| *Getter* | get_tonemap_auto_exposure() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_tonemap_auto_exposure(value) | ++-----------+----------------------------------+ +| *Getter* | get_tonemap_auto_exposure() | ++-----------+----------------------------------+ Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light. @@ -455,11 +473,13 @@ Enables the tonemapping auto exposure mode of the scene renderer. If activated, - :ref:`float` **auto_exposure_max_luma** -+----------+--------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_max(value) | -+----------+--------------------------------------+ -| *Getter* | get_tonemap_auto_exposure_max() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | 8.0 | ++-----------+--------------------------------------+ +| *Setter* | set_tonemap_auto_exposure_max(value) | ++-----------+--------------------------------------+ +| *Getter* | get_tonemap_auto_exposure_max() | ++-----------+--------------------------------------+ Maximum luminance value for the auto exposure. @@ -467,11 +487,13 @@ Maximum luminance value for the auto exposure. - :ref:`float` **auto_exposure_min_luma** -+----------+--------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_min(value) | -+----------+--------------------------------------+ -| *Getter* | get_tonemap_auto_exposure_min() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | 0.05 | ++-----------+--------------------------------------+ +| *Setter* | set_tonemap_auto_exposure_min(value) | ++-----------+--------------------------------------+ +| *Getter* | get_tonemap_auto_exposure_min() | ++-----------+--------------------------------------+ Minimum luminance value for the auto exposure. @@ -479,11 +501,13 @@ Minimum luminance value for the auto exposure. - :ref:`float` **auto_exposure_scale** -+----------+---------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_grey(value) | -+----------+---------------------------------------+ -| *Getter* | get_tonemap_auto_exposure_grey() | -+----------+---------------------------------------+ ++-----------+---------------------------------------+ +| *Default* | 0.4 | ++-----------+---------------------------------------+ +| *Setter* | set_tonemap_auto_exposure_grey(value) | ++-----------+---------------------------------------+ +| *Getter* | get_tonemap_auto_exposure_grey() | ++-----------+---------------------------------------+ Scale of the auto exposure effect. Affects the intensity of auto exposure. @@ -491,11 +515,13 @@ Scale of the auto exposure effect. Affects the intensity of auto exposure. - :ref:`float` **auto_exposure_speed** -+----------+----------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_speed(value) | -+----------+----------------------------------------+ -| *Getter* | get_tonemap_auto_exposure_speed() | -+----------+----------------------------------------+ ++-----------+----------------------------------------+ +| *Default* | 0.5 | ++-----------+----------------------------------------+ +| *Setter* | set_tonemap_auto_exposure_speed(value) | ++-----------+----------------------------------------+ +| *Getter* | get_tonemap_auto_exposure_speed() | ++-----------+----------------------------------------+ Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. @@ -503,11 +529,13 @@ Speed of the auto exposure effect. Affects the time needed for the camera to per - :ref:`int` **background_camera_feed_id** -+----------+---------------------------+ -| *Setter* | set_camera_feed_id(value) | -+----------+---------------------------+ -| *Getter* | get_camera_feed_id() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_camera_feed_id(value) | ++-----------+---------------------------+ +| *Getter* | get_camera_feed_id() | ++-----------+---------------------------+ The id of the camera feed to show in the background. @@ -515,11 +543,13 @@ The id of the camera feed to show in the background. - :ref:`int` **background_canvas_max_layer** -+----------+-----------------------------+ -| *Setter* | set_canvas_max_layer(value) | -+----------+-----------------------------+ -| *Getter* | get_canvas_max_layer() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0 | ++-----------+-----------------------------+ +| *Setter* | set_canvas_max_layer(value) | ++-----------+-----------------------------+ +| *Getter* | get_canvas_max_layer() | ++-----------+-----------------------------+ Maximum layer id (if using Layer background mode). @@ -527,11 +557,13 @@ Maximum layer id (if using Layer background mode). - :ref:`Color` **background_color** -+----------+---------------------+ -| *Setter* | set_bg_color(value) | -+----------+---------------------+ -| *Getter* | get_bg_color() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Color( 0, 0, 0, 1 ) | ++-----------+---------------------+ +| *Setter* | set_bg_color(value) | ++-----------+---------------------+ +| *Getter* | get_bg_color() | ++-----------+---------------------+ Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). @@ -539,11 +571,13 @@ Color displayed for clear areas of the scene (if using Custom color or Color+Sky - :ref:`float` **background_energy** -+----------+----------------------+ -| *Setter* | set_bg_energy(value) | -+----------+----------------------+ -| *Getter* | get_bg_energy() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1.0 | ++-----------+----------------------+ +| *Setter* | set_bg_energy(value) | ++-----------+----------------------+ +| *Getter* | get_bg_energy() | ++-----------+----------------------+ Power of light emitted by the background. @@ -551,11 +585,13 @@ Power of light emitted by the background. - :ref:`BGMode` **background_mode** -+----------+-----------------------+ -| *Setter* | set_background(value) | -+----------+-----------------------+ -| *Getter* | get_background() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_background(value) | ++-----------+-----------------------+ +| *Getter* | get_background() | ++-----------+-----------------------+ Defines the mode of background. @@ -563,11 +599,13 @@ Defines the mode of background. - :ref:`Sky` **background_sky** -+----------+----------------+ -| *Setter* | set_sky(value) | -+----------+----------------+ -| *Getter* | get_sky() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | null | ++-----------+----------------+ +| *Setter* | set_sky(value) | ++-----------+----------------+ +| *Getter* | get_sky() | ++-----------+----------------+ :ref:`Sky` resource defined as background. @@ -575,11 +613,13 @@ Defines the mode of background. - :ref:`float` **background_sky_custom_fov** -+----------+---------------------------+ -| *Setter* | set_sky_custom_fov(value) | -+----------+---------------------------+ -| *Getter* | get_sky_custom_fov() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0.0 | ++-----------+---------------------------+ +| *Setter* | set_sky_custom_fov(value) | ++-----------+---------------------------+ +| *Getter* | get_sky_custom_fov() | ++-----------+---------------------------+ :ref:`Sky` resource's custom field of view. @@ -587,11 +627,13 @@ Defines the mode of background. - :ref:`Basis` **background_sky_orientation** -+----------+----------------------------+ -| *Setter* | set_sky_orientation(value) | -+----------+----------------------------+ -| *Getter* | get_sky_orientation() | -+----------+----------------------------+ ++-----------+------------------------------------+ +| *Default* | Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 ) | ++-----------+------------------------------------+ +| *Setter* | set_sky_orientation(value) | ++-----------+------------------------------------+ +| *Getter* | get_sky_orientation() | ++-----------+------------------------------------+ :ref:`Sky` resource's rotation expressed as a :ref:`Basis` @@ -599,11 +641,13 @@ Defines the mode of background. - :ref:`Vector3` **background_sky_rotation** -+----------+-------------------------+ -| *Setter* | set_sky_rotation(value) | -+----------+-------------------------+ -| *Getter* | get_sky_rotation() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+-------------------------+ +| *Setter* | set_sky_rotation(value) | ++-----------+-------------------------+ +| *Getter* | get_sky_rotation() | ++-----------+-------------------------+ :ref:`Sky` resource's rotation expressed as euler angles in radians @@ -611,11 +655,13 @@ Defines the mode of background. - :ref:`Vector3` **background_sky_rotation_degrees** -+----------+---------------------------------+ -| *Setter* | set_sky_rotation_degrees(value) | -+----------+---------------------------------+ -| *Getter* | get_sky_rotation_degrees() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+---------------------------------+ +| *Setter* | set_sky_rotation_degrees(value) | ++-----------+---------------------------------+ +| *Getter* | get_sky_rotation_degrees() | ++-----------+---------------------------------+ :ref:`Sky` resource's rotation expressed as euler angles in degrees @@ -623,11 +669,13 @@ Defines the mode of background. - :ref:`float` **dof_blur_far_amount** -+----------+--------------------------------+ -| *Setter* | set_dof_blur_far_amount(value) | -+----------+--------------------------------+ -| *Getter* | get_dof_blur_far_amount() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.1 | ++-----------+--------------------------------+ +| *Setter* | set_dof_blur_far_amount(value) | ++-----------+--------------------------------+ +| *Getter* | get_dof_blur_far_amount() | ++-----------+--------------------------------+ Amount of far blur. @@ -635,11 +683,13 @@ Amount of far blur. - :ref:`float` **dof_blur_far_distance** -+----------+----------------------------------+ -| *Setter* | set_dof_blur_far_distance(value) | -+----------+----------------------------------+ -| *Getter* | get_dof_blur_far_distance() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 10.0 | ++-----------+----------------------------------+ +| *Setter* | set_dof_blur_far_distance(value) | ++-----------+----------------------------------+ +| *Getter* | get_dof_blur_far_distance() | ++-----------+----------------------------------+ Distance from the camera where the far blur effect affects the rendering. @@ -647,11 +697,13 @@ Distance from the camera where the far blur effect affects the rendering. - :ref:`bool` **dof_blur_far_enabled** -+----------+---------------------------------+ -| *Setter* | set_dof_blur_far_enabled(value) | -+----------+---------------------------------+ -| *Getter* | is_dof_blur_far_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_dof_blur_far_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | is_dof_blur_far_enabled() | ++-----------+---------------------------------+ Enables the far blur effect. @@ -659,11 +711,13 @@ Enables the far blur effect. - :ref:`DOFBlurQuality` **dof_blur_far_quality** -+----------+---------------------------------+ -| *Setter* | set_dof_blur_far_quality(value) | -+----------+---------------------------------+ -| *Getter* | get_dof_blur_far_quality() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 1 | ++-----------+---------------------------------+ +| *Setter* | set_dof_blur_far_quality(value) | ++-----------+---------------------------------+ +| *Getter* | get_dof_blur_far_quality() | ++-----------+---------------------------------+ Quality of the far blur quality. @@ -671,11 +725,13 @@ Quality of the far blur quality. - :ref:`float` **dof_blur_far_transition** -+----------+------------------------------------+ -| *Setter* | set_dof_blur_far_transition(value) | -+----------+------------------------------------+ -| *Getter* | get_dof_blur_far_transition() | -+----------+------------------------------------+ ++-----------+------------------------------------+ +| *Default* | 5.0 | ++-----------+------------------------------------+ +| *Setter* | set_dof_blur_far_transition(value) | ++-----------+------------------------------------+ +| *Getter* | get_dof_blur_far_transition() | ++-----------+------------------------------------+ Transition between no-blur area and far blur. @@ -683,11 +739,13 @@ Transition between no-blur area and far blur. - :ref:`float` **dof_blur_near_amount** -+----------+---------------------------------+ -| *Setter* | set_dof_blur_near_amount(value) | -+----------+---------------------------------+ -| *Getter* | get_dof_blur_near_amount() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 0.1 | ++-----------+---------------------------------+ +| *Setter* | set_dof_blur_near_amount(value) | ++-----------+---------------------------------+ +| *Getter* | get_dof_blur_near_amount() | ++-----------+---------------------------------+ Amount of near blur. @@ -695,11 +753,13 @@ Amount of near blur. - :ref:`float` **dof_blur_near_distance** -+----------+-----------------------------------+ -| *Setter* | set_dof_blur_near_distance(value) | -+----------+-----------------------------------+ -| *Getter* | get_dof_blur_near_distance() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | 2.0 | ++-----------+-----------------------------------+ +| *Setter* | set_dof_blur_near_distance(value) | ++-----------+-----------------------------------+ +| *Getter* | get_dof_blur_near_distance() | ++-----------+-----------------------------------+ Distance from the camera where the near blur effect affects the rendering. @@ -707,11 +767,13 @@ Distance from the camera where the near blur effect affects the rendering. - :ref:`bool` **dof_blur_near_enabled** -+----------+----------------------------------+ -| *Setter* | set_dof_blur_near_enabled(value) | -+----------+----------------------------------+ -| *Getter* | is_dof_blur_near_enabled() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_dof_blur_near_enabled(value) | ++-----------+----------------------------------+ +| *Getter* | is_dof_blur_near_enabled() | ++-----------+----------------------------------+ Enables the near blur effect. @@ -719,11 +781,13 @@ Enables the near blur effect. - :ref:`DOFBlurQuality` **dof_blur_near_quality** -+----------+----------------------------------+ -| *Setter* | set_dof_blur_near_quality(value) | -+----------+----------------------------------+ -| *Getter* | get_dof_blur_near_quality() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 1 | ++-----------+----------------------------------+ +| *Setter* | set_dof_blur_near_quality(value) | ++-----------+----------------------------------+ +| *Getter* | get_dof_blur_near_quality() | ++-----------+----------------------------------+ Quality of the near blur quality. @@ -731,11 +795,13 @@ Quality of the near blur quality. - :ref:`float` **dof_blur_near_transition** -+----------+-------------------------------------+ -| *Setter* | set_dof_blur_near_transition(value) | -+----------+-------------------------------------+ -| *Getter* | get_dof_blur_near_transition() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | 1.0 | ++-----------+-------------------------------------+ +| *Setter* | set_dof_blur_near_transition(value) | ++-----------+-------------------------------------+ +| *Getter* | get_dof_blur_near_transition() | ++-----------+-------------------------------------+ Transition between near blur and no-blur area. @@ -743,11 +809,13 @@ Transition between near blur and no-blur area. - :ref:`Color` **fog_color** -+----------+----------------------+ -| *Setter* | set_fog_color(value) | -+----------+----------------------+ -| *Getter* | get_fog_color() | -+----------+----------------------+ ++-----------+---------------------------+ +| *Default* | Color( 0.5, 0.6, 0.7, 1 ) | ++-----------+---------------------------+ +| *Setter* | set_fog_color(value) | ++-----------+---------------------------+ +| *Getter* | get_fog_color() | ++-----------+---------------------------+ Fog's :ref:`Color`. @@ -755,11 +823,13 @@ Fog's :ref:`Color`. - :ref:`float` **fog_depth_begin** -+----------+----------------------------+ -| *Setter* | set_fog_depth_begin(value) | -+----------+----------------------------+ -| *Getter* | get_fog_depth_begin() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 10.0 | ++-----------+----------------------------+ +| *Setter* | set_fog_depth_begin(value) | ++-----------+----------------------------+ +| *Getter* | get_fog_depth_begin() | ++-----------+----------------------------+ Fog's depth starting distance from the camera. @@ -767,11 +837,13 @@ Fog's depth starting distance from the camera. - :ref:`float` **fog_depth_curve** -+----------+----------------------------+ -| *Setter* | set_fog_depth_curve(value) | -+----------+----------------------------+ -| *Getter* | get_fog_depth_curve() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1.0 | ++-----------+----------------------------+ +| *Setter* | set_fog_depth_curve(value) | ++-----------+----------------------------+ +| *Getter* | get_fog_depth_curve() | ++-----------+----------------------------+ Value defining the fog depth intensity. @@ -779,11 +851,13 @@ Value defining the fog depth intensity. - :ref:`bool` **fog_depth_enabled** -+----------+------------------------------+ -| *Setter* | set_fog_depth_enabled(value) | -+----------+------------------------------+ -| *Getter* | is_fog_depth_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | true | ++-----------+------------------------------+ +| *Setter* | set_fog_depth_enabled(value) | ++-----------+------------------------------+ +| *Getter* | is_fog_depth_enabled() | ++-----------+------------------------------+ Enables the fog depth. @@ -791,21 +865,25 @@ Enables the fog depth. - :ref:`float` **fog_depth_end** -+----------+--------------------------+ -| *Setter* | set_fog_depth_end(value) | -+----------+--------------------------+ -| *Getter* | get_fog_depth_end() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------+ +| *Setter* | set_fog_depth_end(value) | ++-----------+--------------------------+ +| *Getter* | get_fog_depth_end() | ++-----------+--------------------------+ .. _class_Environment_property_fog_enabled: - :ref:`bool` **fog_enabled** -+----------+------------------------+ -| *Setter* | set_fog_enabled(value) | -+----------+------------------------+ -| *Getter* | is_fog_enabled() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_fog_enabled(value) | ++-----------+------------------------+ +| *Getter* | is_fog_enabled() | ++-----------+------------------------+ Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. @@ -813,11 +891,13 @@ Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually d - :ref:`float` **fog_height_curve** -+----------+-----------------------------+ -| *Setter* | set_fog_height_curve(value) | -+----------+-----------------------------+ -| *Getter* | get_fog_height_curve() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 1.0 | ++-----------+-----------------------------+ +| *Setter* | set_fog_height_curve(value) | ++-----------+-----------------------------+ +| *Getter* | get_fog_height_curve() | ++-----------+-----------------------------+ Value defining the fog height intensity. @@ -825,11 +905,13 @@ Value defining the fog height intensity. - :ref:`bool` **fog_height_enabled** -+----------+-------------------------------+ -| *Setter* | set_fog_height_enabled(value) | -+----------+-------------------------------+ -| *Getter* | is_fog_height_enabled() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | false | ++-----------+-------------------------------+ +| *Setter* | set_fog_height_enabled(value) | ++-----------+-------------------------------+ +| *Getter* | is_fog_height_enabled() | ++-----------+-------------------------------+ Enables the fog height. @@ -837,11 +919,13 @@ Enables the fog height. - :ref:`float` **fog_height_max** -+----------+---------------------------+ -| *Setter* | set_fog_height_max(value) | -+----------+---------------------------+ -| *Getter* | get_fog_height_max() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 100.0 | ++-----------+---------------------------+ +| *Setter* | set_fog_height_max(value) | ++-----------+---------------------------+ +| *Getter* | get_fog_height_max() | ++-----------+---------------------------+ Maximum height of fog. @@ -849,11 +933,13 @@ Maximum height of fog. - :ref:`float` **fog_height_min** -+----------+---------------------------+ -| *Setter* | set_fog_height_min(value) | -+----------+---------------------------+ -| *Getter* | get_fog_height_min() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0.0 | ++-----------+---------------------------+ +| *Setter* | set_fog_height_min(value) | ++-----------+---------------------------+ +| *Getter* | get_fog_height_min() | ++-----------+---------------------------+ Minimum height of fog. @@ -861,11 +947,13 @@ Minimum height of fog. - :ref:`float` **fog_sun_amount** -+----------+---------------------------+ -| *Setter* | set_fog_sun_amount(value) | -+----------+---------------------------+ -| *Getter* | get_fog_sun_amount() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0.0 | ++-----------+---------------------------+ +| *Setter* | set_fog_sun_amount(value) | ++-----------+---------------------------+ +| *Getter* | get_fog_sun_amount() | ++-----------+---------------------------+ Amount of sun that affects the fog rendering. @@ -873,11 +961,13 @@ Amount of sun that affects the fog rendering. - :ref:`Color` **fog_sun_color** -+----------+--------------------------+ -| *Setter* | set_fog_sun_color(value) | -+----------+--------------------------+ -| *Getter* | get_fog_sun_color() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Color( 1, 0.9, 0.7, 1 ) | ++-----------+--------------------------+ +| *Setter* | set_fog_sun_color(value) | ++-----------+--------------------------+ +| *Getter* | get_fog_sun_color() | ++-----------+--------------------------+ Sun :ref:`Color`. @@ -885,11 +975,13 @@ Sun :ref:`Color`. - :ref:`float` **fog_transmit_curve** -+----------+-------------------------------+ -| *Setter* | set_fog_transmit_curve(value) | -+----------+-------------------------------+ -| *Getter* | get_fog_transmit_curve() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 1.0 | ++-----------+-------------------------------+ +| *Setter* | set_fog_transmit_curve(value) | ++-----------+-------------------------------+ +| *Getter* | get_fog_transmit_curve() | ++-----------+-------------------------------+ Amount of light that the fog transmits. @@ -897,11 +989,13 @@ Amount of light that the fog transmits. - :ref:`bool` **fog_transmit_enabled** -+----------+---------------------------------+ -| *Setter* | set_fog_transmit_enabled(value) | -+----------+---------------------------------+ -| *Getter* | is_fog_transmit_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_fog_transmit_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | is_fog_transmit_enabled() | ++-----------+---------------------------------+ Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. @@ -909,21 +1003,25 @@ Enables fog's light transmission. If enabled, lets reflections light to be trans - :ref:`bool` **glow_bicubic_upscale** -+----------+-----------------------------------+ -| *Setter* | set_glow_bicubic_upscale(value) | -+----------+-----------------------------------+ -| *Getter* | is_glow_bicubic_upscale_enabled() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | false | ++-----------+-----------------------------------+ +| *Setter* | set_glow_bicubic_upscale(value) | ++-----------+-----------------------------------+ +| *Getter* | is_glow_bicubic_upscale_enabled() | ++-----------+-----------------------------------+ .. _class_Environment_property_glow_blend_mode: - :ref:`GlowBlendMode` **glow_blend_mode** -+----------+----------------------------+ -| *Setter* | set_glow_blend_mode(value) | -+----------+----------------------------+ -| *Getter* | get_glow_blend_mode() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 2 | ++-----------+----------------------------+ +| *Setter* | set_glow_blend_mode(value) | ++-----------+----------------------------+ +| *Getter* | get_glow_blend_mode() | ++-----------+----------------------------+ Glow blending mode. @@ -931,11 +1029,13 @@ Glow blending mode. - :ref:`float` **glow_bloom** -+----------+-----------------------+ -| *Setter* | set_glow_bloom(value) | -+----------+-----------------------+ -| *Getter* | get_glow_bloom() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0.0 | ++-----------+-----------------------+ +| *Setter* | set_glow_bloom(value) | ++-----------+-----------------------+ +| *Getter* | get_glow_bloom() | ++-----------+-----------------------+ Bloom value (global glow). @@ -943,11 +1043,13 @@ Bloom value (global glow). - :ref:`bool` **glow_enabled** -+----------+-------------------------+ -| *Setter* | set_glow_enabled(value) | -+----------+-------------------------+ -| *Getter* | is_glow_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_glow_enabled(value) | ++-----------+-------------------------+ +| *Getter* | is_glow_enabled() | ++-----------+-------------------------+ Enables glow rendering. @@ -955,21 +1057,25 @@ Enables glow rendering. - :ref:`float` **glow_hdr_luminance_cap** -+----------+-----------------------------------+ -| *Setter* | set_glow_hdr_luminance_cap(value) | -+----------+-----------------------------------+ -| *Getter* | get_glow_hdr_luminance_cap() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | 12.0 | ++-----------+-----------------------------------+ +| *Setter* | set_glow_hdr_luminance_cap(value) | ++-----------+-----------------------------------+ +| *Getter* | get_glow_hdr_luminance_cap() | ++-----------+-----------------------------------+ .. _class_Environment_property_glow_hdr_scale: - :ref:`float` **glow_hdr_scale** -+----------+---------------------------------+ -| *Setter* | set_glow_hdr_bleed_scale(value) | -+----------+---------------------------------+ -| *Getter* | get_glow_hdr_bleed_scale() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 2.0 | ++-----------+---------------------------------+ +| *Setter* | set_glow_hdr_bleed_scale(value) | ++-----------+---------------------------------+ +| *Getter* | get_glow_hdr_bleed_scale() | ++-----------+---------------------------------+ Bleed scale of the HDR glow. @@ -977,11 +1083,13 @@ Bleed scale of the HDR glow. - :ref:`float` **glow_hdr_threshold** -+----------+-------------------------------------+ -| *Setter* | set_glow_hdr_bleed_threshold(value) | -+----------+-------------------------------------+ -| *Getter* | get_glow_hdr_bleed_threshold() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | 1.0 | ++-----------+-------------------------------------+ +| *Setter* | set_glow_hdr_bleed_threshold(value) | ++-----------+-------------------------------------+ +| *Getter* | get_glow_hdr_bleed_threshold() | ++-----------+-------------------------------------+ Bleed threshold of the HDR glow. @@ -989,11 +1097,13 @@ Bleed threshold of the HDR glow. - :ref:`float` **glow_intensity** -+----------+---------------------------+ -| *Setter* | set_glow_intensity(value) | -+----------+---------------------------+ -| *Getter* | get_glow_intensity() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0.8 | ++-----------+---------------------------+ +| *Setter* | set_glow_intensity(value) | ++-----------+---------------------------+ +| *Getter* | get_glow_intensity() | ++-----------+---------------------------+ Glow intensity. @@ -1001,11 +1111,13 @@ Glow intensity. - :ref:`bool` **glow_levels/1** -+----------+-------------------------+ -| *Setter* | set_glow_level(value) | -+----------+-------------------------+ -| *Getter* | is_glow_level_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++-----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++-----------+-------------------------+ First level of glow (most local). @@ -1013,11 +1125,13 @@ First level of glow (most local). - :ref:`bool` **glow_levels/2** -+----------+-------------------------+ -| *Setter* | set_glow_level(value) | -+----------+-------------------------+ -| *Getter* | is_glow_level_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++-----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++-----------+-------------------------+ Second level of glow. @@ -1025,11 +1139,13 @@ Second level of glow. - :ref:`bool` **glow_levels/3** -+----------+-------------------------+ -| *Setter* | set_glow_level(value) | -+----------+-------------------------+ -| *Getter* | is_glow_level_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | true | ++-----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++-----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++-----------+-------------------------+ Third level of glow. @@ -1037,11 +1153,13 @@ Third level of glow. - :ref:`bool` **glow_levels/4** -+----------+-------------------------+ -| *Setter* | set_glow_level(value) | -+----------+-------------------------+ -| *Getter* | is_glow_level_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++-----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++-----------+-------------------------+ Fourth level of glow. @@ -1049,11 +1167,13 @@ Fourth level of glow. - :ref:`bool` **glow_levels/5** -+----------+-------------------------+ -| *Setter* | set_glow_level(value) | -+----------+-------------------------+ -| *Getter* | is_glow_level_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | true | ++-----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++-----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++-----------+-------------------------+ Fifth level of glow. @@ -1061,11 +1181,13 @@ Fifth level of glow. - :ref:`bool` **glow_levels/6** -+----------+-------------------------+ -| *Setter* | set_glow_level(value) | -+----------+-------------------------+ -| *Getter* | is_glow_level_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++-----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++-----------+-------------------------+ Sixth level of glow. @@ -1073,11 +1195,13 @@ Sixth level of glow. - :ref:`bool` **glow_levels/7** -+----------+-------------------------+ -| *Setter* | set_glow_level(value) | -+----------+-------------------------+ -| *Getter* | is_glow_level_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++-----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++-----------+-------------------------+ Seventh level of glow (most global). @@ -1085,11 +1209,13 @@ Seventh level of glow (most global). - :ref:`float` **glow_strength** -+----------+--------------------------+ -| *Setter* | set_glow_strength(value) | -+----------+--------------------------+ -| *Getter* | get_glow_strength() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_glow_strength(value) | ++-----------+--------------------------+ +| *Getter* | get_glow_strength() | ++-----------+--------------------------+ Glow strength. @@ -1097,191 +1223,229 @@ Glow strength. - :ref:`float` **ss_reflections_depth_tolerance** -+----------+--------------------------------+ -| *Setter* | set_ssr_depth_tolerance(value) | -+----------+--------------------------------+ -| *Getter* | get_ssr_depth_tolerance() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.2 | ++-----------+--------------------------------+ +| *Setter* | set_ssr_depth_tolerance(value) | ++-----------+--------------------------------+ +| *Getter* | get_ssr_depth_tolerance() | ++-----------+--------------------------------+ .. _class_Environment_property_ss_reflections_enabled: - :ref:`bool` **ss_reflections_enabled** -+----------+------------------------+ -| *Setter* | set_ssr_enabled(value) | -+----------+------------------------+ -| *Getter* | is_ssr_enabled() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_ssr_enabled(value) | ++-----------+------------------------+ +| *Getter* | is_ssr_enabled() | ++-----------+------------------------+ .. _class_Environment_property_ss_reflections_fade_in: - :ref:`float` **ss_reflections_fade_in** -+----------+------------------------+ -| *Setter* | set_ssr_fade_in(value) | -+----------+------------------------+ -| *Getter* | get_ssr_fade_in() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.15 | ++-----------+------------------------+ +| *Setter* | set_ssr_fade_in(value) | ++-----------+------------------------+ +| *Getter* | get_ssr_fade_in() | ++-----------+------------------------+ .. _class_Environment_property_ss_reflections_fade_out: - :ref:`float` **ss_reflections_fade_out** -+----------+-------------------------+ -| *Setter* | set_ssr_fade_out(value) | -+----------+-------------------------+ -| *Getter* | get_ssr_fade_out() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 2.0 | ++-----------+-------------------------+ +| *Setter* | set_ssr_fade_out(value) | ++-----------+-------------------------+ +| *Getter* | get_ssr_fade_out() | ++-----------+-------------------------+ .. _class_Environment_property_ss_reflections_max_steps: - :ref:`int` **ss_reflections_max_steps** -+----------+--------------------------+ -| *Setter* | set_ssr_max_steps(value) | -+----------+--------------------------+ -| *Getter* | get_ssr_max_steps() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 64 | ++-----------+--------------------------+ +| *Setter* | set_ssr_max_steps(value) | ++-----------+--------------------------+ +| *Getter* | get_ssr_max_steps() | ++-----------+--------------------------+ .. _class_Environment_property_ss_reflections_roughness: - :ref:`bool` **ss_reflections_roughness** -+----------+----------------------+ -| *Setter* | set_ssr_rough(value) | -+----------+----------------------+ -| *Getter* | is_ssr_rough() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_ssr_rough(value) | ++-----------+----------------------+ +| *Getter* | is_ssr_rough() | ++-----------+----------------------+ .. _class_Environment_property_ssao_ao_channel_affect: - :ref:`float` **ssao_ao_channel_affect** -+----------+-----------------------------------+ -| *Setter* | set_ssao_ao_channel_affect(value) | -+----------+-----------------------------------+ -| *Getter* | get_ssao_ao_channel_affect() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------------+ +| *Setter* | set_ssao_ao_channel_affect(value) | ++-----------+-----------------------------------+ +| *Getter* | get_ssao_ao_channel_affect() | ++-----------+-----------------------------------+ .. _class_Environment_property_ssao_bias: - :ref:`float` **ssao_bias** -+----------+----------------------+ -| *Setter* | set_ssao_bias(value) | -+----------+----------------------+ -| *Getter* | get_ssao_bias() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0.01 | ++-----------+----------------------+ +| *Setter* | set_ssao_bias(value) | ++-----------+----------------------+ +| *Getter* | get_ssao_bias() | ++-----------+----------------------+ .. _class_Environment_property_ssao_blur: - :ref:`SSAOBlur` **ssao_blur** -+----------+----------------------+ -| *Setter* | set_ssao_blur(value) | -+----------+----------------------+ -| *Getter* | get_ssao_blur() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 3 | ++-----------+----------------------+ +| *Setter* | set_ssao_blur(value) | ++-----------+----------------------+ +| *Getter* | get_ssao_blur() | ++-----------+----------------------+ .. _class_Environment_property_ssao_color: - :ref:`Color` **ssao_color** -+----------+-----------------------+ -| *Setter* | set_ssao_color(value) | -+----------+-----------------------+ -| *Getter* | get_ssao_color() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | Color( 0, 0, 0, 1 ) | ++-----------+-----------------------+ +| *Setter* | set_ssao_color(value) | ++-----------+-----------------------+ +| *Getter* | get_ssao_color() | ++-----------+-----------------------+ .. _class_Environment_property_ssao_edge_sharpness: - :ref:`float` **ssao_edge_sharpness** -+----------+--------------------------------+ -| *Setter* | set_ssao_edge_sharpness(value) | -+----------+--------------------------------+ -| *Getter* | get_ssao_edge_sharpness() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 4.0 | ++-----------+--------------------------------+ +| *Setter* | set_ssao_edge_sharpness(value) | ++-----------+--------------------------------+ +| *Getter* | get_ssao_edge_sharpness() | ++-----------+--------------------------------+ .. _class_Environment_property_ssao_enabled: - :ref:`bool` **ssao_enabled** -+----------+-------------------------+ -| *Setter* | set_ssao_enabled(value) | -+----------+-------------------------+ -| *Getter* | is_ssao_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_ssao_enabled(value) | ++-----------+-------------------------+ +| *Getter* | is_ssao_enabled() | ++-----------+-------------------------+ .. _class_Environment_property_ssao_intensity: - :ref:`float` **ssao_intensity** -+----------+---------------------------+ -| *Setter* | set_ssao_intensity(value) | -+----------+---------------------------+ -| *Getter* | get_ssao_intensity() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1.0 | ++-----------+---------------------------+ +| *Setter* | set_ssao_intensity(value) | ++-----------+---------------------------+ +| *Getter* | get_ssao_intensity() | ++-----------+---------------------------+ .. _class_Environment_property_ssao_intensity2: - :ref:`float` **ssao_intensity2** -+----------+----------------------------+ -| *Setter* | set_ssao_intensity2(value) | -+----------+----------------------------+ -| *Getter* | get_ssao_intensity2() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1.0 | ++-----------+----------------------------+ +| *Setter* | set_ssao_intensity2(value) | ++-----------+----------------------------+ +| *Getter* | get_ssao_intensity2() | ++-----------+----------------------------+ .. _class_Environment_property_ssao_light_affect: - :ref:`float` **ssao_light_affect** -+----------+-------------------------------------+ -| *Setter* | set_ssao_direct_light_affect(value) | -+----------+-------------------------------------+ -| *Getter* | get_ssao_direct_light_affect() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------------+ +| *Setter* | set_ssao_direct_light_affect(value) | ++-----------+-------------------------------------+ +| *Getter* | get_ssao_direct_light_affect() | ++-----------+-------------------------------------+ .. _class_Environment_property_ssao_quality: - :ref:`SSAOQuality` **ssao_quality** -+----------+-------------------------+ -| *Setter* | set_ssao_quality(value) | -+----------+-------------------------+ -| *Getter* | get_ssao_quality() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 1 | ++-----------+-------------------------+ +| *Setter* | set_ssao_quality(value) | ++-----------+-------------------------+ +| *Getter* | get_ssao_quality() | ++-----------+-------------------------+ .. _class_Environment_property_ssao_radius: - :ref:`float` **ssao_radius** -+----------+------------------------+ -| *Setter* | set_ssao_radius(value) | -+----------+------------------------+ -| *Getter* | get_ssao_radius() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1.0 | ++-----------+------------------------+ +| *Setter* | set_ssao_radius(value) | ++-----------+------------------------+ +| *Getter* | get_ssao_radius() | ++-----------+------------------------+ .. _class_Environment_property_ssao_radius2: - :ref:`float` **ssao_radius2** -+----------+-------------------------+ -| *Setter* | set_ssao_radius2(value) | -+----------+-------------------------+ -| *Getter* | get_ssao_radius2() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------+ +| *Setter* | set_ssao_radius2(value) | ++-----------+-------------------------+ +| *Getter* | get_ssao_radius2() | ++-----------+-------------------------+ .. _class_Environment_property_tonemap_exposure: - :ref:`float` **tonemap_exposure** -+----------+-----------------------------+ -| *Setter* | set_tonemap_exposure(value) | -+----------+-----------------------------+ -| *Getter* | get_tonemap_exposure() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 1.0 | ++-----------+-----------------------------+ +| *Setter* | set_tonemap_exposure(value) | ++-----------+-----------------------------+ +| *Getter* | get_tonemap_exposure() | ++-----------+-----------------------------+ Default exposure for tonemap. @@ -1289,11 +1453,13 @@ Default exposure for tonemap. - :ref:`ToneMapper` **tonemap_mode** -+----------+-----------------------+ -| *Setter* | set_tonemapper(value) | -+----------+-----------------------+ -| *Getter* | get_tonemapper() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_tonemapper(value) | ++-----------+-----------------------+ +| *Getter* | get_tonemapper() | ++-----------+-----------------------+ Tonemapping mode. @@ -1301,11 +1467,13 @@ Tonemapping mode. - :ref:`float` **tonemap_white** -+----------+--------------------------+ -| *Setter* | set_tonemap_white(value) | -+----------+--------------------------+ -| *Getter* | get_tonemap_white() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_tonemap_white(value) | ++-----------+--------------------------+ +| *Getter* | get_tonemap_white() | ++-----------+--------------------------+ White reference value for tonemap. diff --git a/classes/class_file.rst b/classes/class_file.rst index 6c24d7225..2570492b9 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -19,9 +19,9 @@ Type to handle file reading and writing operations. Properties ---------- -+-------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`endian_swap` | -+-------------------------+-----------------------------------------------------+ ++-------------------------+-----------------------------------------------------+-------+ +| :ref:`bool` | :ref:`endian_swap` | false | ++-------------------------+-----------------------------------------------------+-------+ Methods ------- @@ -193,11 +193,13 @@ Property Descriptions - :ref:`bool` **endian_swap** -+----------+------------------------+ -| *Setter* | set_endian_swap(value) | -+----------+------------------------+ -| *Getter* | get_endian_swap() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_endian_swap(value) | ++-----------+------------------------+ +| *Getter* | get_endian_swap() | ++-----------+------------------------+ If ``true``, the file's endianness is swapped. Use this if you're dealing with files written on big-endian machines. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 8b78bde22..24a0f73cd 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -19,23 +19,23 @@ Dialog for selecting files or directories in the filesystem. Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Access` | :ref:`access` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_dir` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_file` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_path` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`filters` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`mode_overrides_title` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_hidden_files` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ +| :ref:`Access` | :ref:`access` | 0 | ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`current_dir` | "res://" | ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`current_file` | "" | ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`current_path` | "res://" | ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ +| :ref:`PoolStringArray` | :ref:`filters` | PoolStringArray( ) | ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ +| :ref:`Mode` | :ref:`mode` | 4 | ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`mode_overrides_title` | true | ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`show_hidden_files` | false | ++-----------------------------------------------+-----------------------------------------------------------------------------+---------------------+ Methods ------- @@ -57,17 +57,17 @@ Methods Theme Properties ---------------- -+-------------------------------+----------------+ -| :ref:`Color` | files_disabled | -+-------------------------------+----------------+ -| :ref:`Texture` | folder | -+-------------------------------+----------------+ -| :ref:`Texture` | parent_folder | -+-------------------------------+----------------+ -| :ref:`Texture` | reload | -+-------------------------------+----------------+ -| :ref:`Texture` | toggle_hidden | -+-------------------------------+----------------+ ++-------------------------------+----------------+-----------------------+ +| :ref:`Color` | files_disabled | Color( 0, 0, 0, 0.7 ) | ++-------------------------------+----------------+-----------------------+ +| :ref:`Texture` | folder | | ++-------------------------------+----------------+-----------------------+ +| :ref:`Texture` | parent_folder | | ++-------------------------------+----------------+-----------------------+ +| :ref:`Texture` | reload | | ++-------------------------------+----------------+-----------------------+ +| :ref:`Texture` | toggle_hidden | | ++-------------------------------+----------------+-----------------------+ Signals ------- @@ -145,11 +145,13 @@ Property Descriptions - :ref:`Access` **access** -+----------+-------------------+ -| *Setter* | set_access(value) | -+----------+-------------------+ -| *Getter* | get_access() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0 | ++-----------+-------------------+ +| *Setter* | set_access(value) | ++-----------+-------------------+ +| *Getter* | get_access() | ++-----------+-------------------+ The file system access scope. See enum ``Access`` constants. @@ -157,11 +159,13 @@ The file system access scope. See enum ``Access`` constants. - :ref:`String` **current_dir** -+----------+------------------------+ -| *Setter* | set_current_dir(value) | -+----------+------------------------+ -| *Getter* | get_current_dir() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | "res://" | ++-----------+------------------------+ +| *Setter* | set_current_dir(value) | ++-----------+------------------------+ +| *Getter* | get_current_dir() | ++-----------+------------------------+ The current working directory of the file dialog. @@ -169,11 +173,13 @@ The current working directory of the file dialog. - :ref:`String` **current_file** -+----------+-------------------------+ -| *Setter* | set_current_file(value) | -+----------+-------------------------+ -| *Getter* | get_current_file() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | "" | ++-----------+-------------------------+ +| *Setter* | set_current_file(value) | ++-----------+-------------------------+ +| *Getter* | get_current_file() | ++-----------+-------------------------+ The currently selected file of the file dialog. @@ -181,11 +187,13 @@ The currently selected file of the file dialog. - :ref:`String` **current_path** -+----------+-------------------------+ -| *Setter* | set_current_path(value) | -+----------+-------------------------+ -| *Getter* | get_current_path() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | "res://" | ++-----------+-------------------------+ +| *Setter* | set_current_path(value) | ++-----------+-------------------------+ +| *Getter* | get_current_path() | ++-----------+-------------------------+ The currently selected file path of the file dialog. @@ -193,11 +201,13 @@ The currently selected file path of the file dialog. - :ref:`PoolStringArray` **filters** -+----------+--------------------+ -| *Setter* | set_filters(value) | -+----------+--------------------+ -| *Getter* | get_filters() | -+----------+--------------------+ ++-----------+---------------------+ +| *Default* | PoolStringArray( ) | ++-----------+---------------------+ +| *Setter* | set_filters(value) | ++-----------+---------------------+ +| *Getter* | get_filters() | ++-----------+---------------------+ The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. @@ -205,11 +215,13 @@ The available file type filters. For example, this shows only ``.png`` and ``.gd - :ref:`Mode` **mode** -+----------+-----------------+ -| *Setter* | set_mode(value) | -+----------+-----------------+ -| *Getter* | get_mode() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 4 | ++-----------+-----------------+ +| *Setter* | set_mode(value) | ++-----------+-----------------+ +| *Getter* | get_mode() | ++-----------+-----------------+ The dialog's open or save mode, which affects the selection behavior. See enum ``Mode`` constants. @@ -217,11 +229,13 @@ The dialog's open or save mode, which affects the selection behavior. See enum ` - :ref:`bool` **mode_overrides_title** -+----------+---------------------------------+ -| *Setter* | set_mode_overrides_title(value) | -+----------+---------------------------------+ -| *Getter* | is_mode_overriding_title() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | true | ++-----------+---------------------------------+ +| *Setter* | set_mode_overrides_title(value) | ++-----------+---------------------------------+ +| *Getter* | is_mode_overriding_title() | ++-----------+---------------------------------+ If ``true``, changing the ``Mode`` property will set the window title accordingly (e.g. setting mode to :ref:`MODE_OPEN_FILE` will change the window title to "Open a File"). @@ -229,11 +243,13 @@ If ``true``, changing the ``Mode`` property will set the window title accordingl - :ref:`bool` **show_hidden_files** -+----------+------------------------------+ -| *Setter* | set_show_hidden_files(value) | -+----------+------------------------------+ -| *Getter* | is_showing_hidden_files() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_show_hidden_files(value) | ++-----------+------------------------------+ +| *Getter* | is_showing_hidden_files() | ++-----------+------------------------------+ If ``true``, the dialog will show hidden files. diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 02d7cc59a..909039764 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------------------------------+-------------------------------------------------+ -| :ref:`GDNativeLibrary` | :ref:`library` | -+-----------------------------------------------+-------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------+------+ +| :ref:`GDNativeLibrary` | :ref:`library` | null | ++-----------------------------------------------+-------------------------------------------------+------+ Methods ------- @@ -41,11 +41,13 @@ Property Descriptions - :ref:`GDNativeLibrary` **library** -+----------+--------------------+ -| *Setter* | set_library(value) | -+----------+--------------------+ -| *Getter* | get_library() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_library(value) | ++-----------+--------------------+ +| *Getter* | get_library() | ++-----------+--------------------+ Method Descriptions ------------------- diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 273c84b30..73f82ff87 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -19,17 +19,17 @@ Brief Description Properties ---------- -+-------------------------------------+--------------------------------------------------------------------+ -| :ref:`ConfigFile` | :ref:`config_file` | -+-------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`load_once` | -+-------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reloadable` | -+-------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`singleton` | -+-------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`symbol_prefix` | -+-------------------------------------+--------------------------------------------------------------------+ ++-------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`ConfigFile` | :ref:`config_file` | | ++-------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`load_once` | true | ++-------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`reloadable` | true | ++-------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`singleton` | false | ++-------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`symbol_prefix` | "godot_" | ++-------------------------------------+--------------------------------------------------------------------+----------+ Methods ------- @@ -57,41 +57,49 @@ Property Descriptions - :ref:`bool` **load_once** -+----------+----------------------+ -| *Setter* | set_load_once(value) | -+----------+----------------------+ -| *Getter* | should_load_once() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_load_once(value) | ++-----------+----------------------+ +| *Getter* | should_load_once() | ++-----------+----------------------+ .. _class_GDNativeLibrary_property_reloadable: - :ref:`bool` **reloadable** -+----------+-----------------------+ -| *Setter* | set_reloadable(value) | -+----------+-----------------------+ -| *Getter* | is_reloadable() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | true | ++-----------+-----------------------+ +| *Setter* | set_reloadable(value) | ++-----------+-----------------------+ +| *Getter* | is_reloadable() | ++-----------+-----------------------+ .. _class_GDNativeLibrary_property_singleton: - :ref:`bool` **singleton** -+----------+----------------------+ -| *Setter* | set_singleton(value) | -+----------+----------------------+ -| *Getter* | is_singleton() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_singleton(value) | ++-----------+----------------------+ +| *Getter* | is_singleton() | ++-----------+----------------------+ .. _class_GDNativeLibrary_property_symbol_prefix: - :ref:`String` **symbol_prefix** -+----------+--------------------------+ -| *Setter* | set_symbol_prefix(value) | -+----------+--------------------------+ -| *Getter* | get_symbol_prefix() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | "godot_" | ++-----------+--------------------------+ +| *Setter* | set_symbol_prefix(value) | ++-----------+--------------------------+ +| *Getter* | get_symbol_prefix() | ++-----------+--------------------------+ Method Descriptions ------------------- diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 674d3027f..7d5bc35a0 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -19,177 +19,177 @@ The generic 6-degrees-of-freedom joint can implement a variety of joint types by Properties ---------- -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_limit_x/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/erp` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/lower_angle` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/restitution` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/softness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/upper_angle` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_limit_y/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/erp` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/lower_angle` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/restitution` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/softness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/upper_angle` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_limit_z/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/erp` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/lower_angle` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/restitution` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/softness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/upper_angle` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_motor_x/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_x/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_x/target_velocity` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_motor_y/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_y/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_y/target_velocity` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_motor_z/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_z/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_z/target_velocity` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_x/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_spring_x/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_x/equilibrium_point` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_x/stiffness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_y/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_spring_y/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_y/equilibrium_point` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_y/stiffness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_z/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_spring_z/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_z/equilibrium_point` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_z/stiffness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_limit_x/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/lower_distance` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/restitution` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/softness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/upper_distance` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_limit_y/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/lower_distance` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/restitution` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/softness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/upper_distance` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_limit_z/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/lower_distance` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/restitution` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/softness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/upper_distance` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_motor_x/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_x/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_x/target_velocity` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_motor_y/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_y/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_y/target_velocity` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_motor_z/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_z/force_limit` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_z/target_velocity` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_x/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_spring_x/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_x/equilibrium_point` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_x/stiffness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_y/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_spring_y/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_y/equilibrium_point` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_y/stiffness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_z/damping` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_spring_z/enabled` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_z/equilibrium_point` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_z/stiffness` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`precision` | -+---------------------------+---------------------------------------------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_x/damping` | 1.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_limit_x/enabled` | true | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_x/erp` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_x/force_limit` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_x/lower_angle` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_x/restitution` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_x/softness` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_x/upper_angle` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_y/damping` | 1.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_limit_y/enabled` | true | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_y/erp` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_y/force_limit` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_y/lower_angle` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_y/restitution` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_y/softness` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_y/upper_angle` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_z/damping` | 1.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_limit_z/enabled` | true | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_z/erp` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_z/force_limit` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_z/lower_angle` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_z/restitution` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_z/softness` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit_z/upper_angle` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_motor_x/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_motor_x/force_limit` | 300.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_motor_x/target_velocity` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_motor_y/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_motor_y/force_limit` | 300.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_motor_y/target_velocity` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_motor_z/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_motor_z/force_limit` | 300.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_motor_z/target_velocity` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_x/damping` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_spring_x/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_x/equilibrium_point` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_x/stiffness` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_y/damping` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_spring_y/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_y/equilibrium_point` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_y/stiffness` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_z/damping` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_spring_z/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_z/equilibrium_point` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_spring_z/stiffness` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_x/damping` | 1.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_limit_x/enabled` | true | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_x/lower_distance` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_x/restitution` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_x/softness` | 0.7 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_x/upper_distance` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_y/damping` | 1.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_limit_y/enabled` | true | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_y/lower_distance` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_y/restitution` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_y/softness` | 0.7 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_y/upper_distance` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_z/damping` | 1.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_limit_z/enabled` | true | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_z/lower_distance` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_z/restitution` | 0.5 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_z/softness` | 0.7 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_limit_z/upper_distance` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_motor_x/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_motor_x/force_limit` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_motor_x/target_velocity` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_motor_y/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_motor_y/force_limit` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_motor_y/target_velocity` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_motor_z/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_motor_z/force_limit` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_motor_z/target_velocity` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_x/damping` | 0.01 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_spring_x/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_x/equilibrium_point` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_x/stiffness` | 0.01 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_y/damping` | 0.01 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_spring_y/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_y/equilibrium_point` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_y/stiffness` | 0.01 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_z/damping` | 0.01 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`linear_spring_z/enabled` | false | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_z/equilibrium_point` | 0.0 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`linear_spring_z/stiffness` | 0.01 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`precision` | 1 | ++---------------------------+---------------------------------------------------------------------------------------------------------------+-------+ Enumerations ------------ @@ -310,11 +310,13 @@ Property Descriptions - :ref:`float` **angular_limit_x/damping** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The amount of rotational damping across the X axis. @@ -324,11 +326,13 @@ The lower, the longer an impulse from one side takes to travel to the other side - :ref:`bool` **angular_limit_x/enabled** -+----------+-------------------+ -| *Setter* | set_flag_x(value) | -+----------+-------------------+ -| *Getter* | get_flag_x() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_flag_x(value) | ++-----------+-------------------+ +| *Getter* | get_flag_x() | ++-----------+-------------------+ If ``true``, rotation across the X axis is limited. @@ -336,11 +340,13 @@ If ``true``, rotation across the X axis is limited. - :ref:`float` **angular_limit_x/erp** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -348,11 +354,13 @@ When rotating across the X axis, this error tolerance factor defines how much th - :ref:`float` **angular_limit_x/force_limit** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The maximum amount of force that can occur, when rotating around the X axis. @@ -360,17 +368,23 @@ The maximum amount of force that can occur, when rotating around the X axis. - :ref:`float` **angular_limit_x/lower_angle** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The minimum rotation in negative direction to break loose and rotate around the X axis. .. _class_Generic6DOFJoint_property_angular_limit_x/restitution: - :ref:`float` **angular_limit_x/restitution** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The amount of rotational restitution across the X axis. The lower, the more restitution occurs. @@ -378,11 +392,13 @@ The amount of rotational restitution across the X axis. The lower, the more rest - :ref:`float` **angular_limit_x/softness** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The speed of all rotations across the X axis. @@ -390,17 +406,23 @@ The speed of all rotations across the X axis. - :ref:`float` **angular_limit_x/upper_angle** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The minimum rotation in positive direction to break loose and rotate around the X axis. .. _class_Generic6DOFJoint_property_angular_limit_y/damping: - :ref:`float` **angular_limit_y/damping** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The amount of rotational damping across the Y axis. The lower, the more dampening occurs. @@ -408,11 +430,13 @@ The amount of rotational damping across the Y axis. The lower, the more dampenin - :ref:`bool` **angular_limit_y/enabled** -+----------+-------------------+ -| *Setter* | set_flag_y(value) | -+----------+-------------------+ -| *Getter* | get_flag_y() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_flag_y(value) | ++-----------+-------------------+ +| *Getter* | get_flag_y() | ++-----------+-------------------+ If ``true``, rotation across the Y axis is limited. @@ -420,11 +444,13 @@ If ``true``, rotation across the Y axis is limited. - :ref:`float` **angular_limit_y/erp** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -432,11 +458,13 @@ When rotating across the Y axis, this error tolerance factor defines how much th - :ref:`float` **angular_limit_y/force_limit** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The maximum amount of force that can occur, when rotating around the Y axis. @@ -444,17 +472,23 @@ The maximum amount of force that can occur, when rotating around the Y axis. - :ref:`float` **angular_limit_y/lower_angle** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The minimum rotation in negative direction to break loose and rotate around the Y axis. .. _class_Generic6DOFJoint_property_angular_limit_y/restitution: - :ref:`float` **angular_limit_y/restitution** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The amount of rotational restitution across the Y axis. The lower, the more restitution occurs. @@ -462,11 +496,13 @@ The amount of rotational restitution across the Y axis. The lower, the more rest - :ref:`float` **angular_limit_y/softness** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The speed of all rotations across the Y axis. @@ -474,17 +510,23 @@ The speed of all rotations across the Y axis. - :ref:`float` **angular_limit_y/upper_angle** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The minimum rotation in positive direction to break loose and rotate around the Y axis. .. _class_Generic6DOFJoint_property_angular_limit_z/damping: - :ref:`float` **angular_limit_z/damping** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The amount of rotational damping across the Z axis. The lower, the more dampening occurs. @@ -492,11 +534,13 @@ The amount of rotational damping across the Z axis. The lower, the more dampenin - :ref:`bool` **angular_limit_z/enabled** -+----------+-------------------+ -| *Setter* | set_flag_z(value) | -+----------+-------------------+ -| *Getter* | get_flag_z() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_flag_z(value) | ++-----------+-------------------+ +| *Getter* | get_flag_z() | ++-----------+-------------------+ If ``true``, rotation across the Z axis is limited. @@ -504,11 +548,13 @@ If ``true``, rotation across the Z axis is limited. - :ref:`float` **angular_limit_z/erp** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -516,11 +562,13 @@ When rotating across the Z axis, this error tolerance factor defines how much th - :ref:`float` **angular_limit_z/force_limit** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The maximum amount of force that can occur, when rotating around the Z axis. @@ -528,17 +576,23 @@ The maximum amount of force that can occur, when rotating around the Z axis. - :ref:`float` **angular_limit_z/lower_angle** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The minimum rotation in negative direction to break loose and rotate around the Z axis. .. _class_Generic6DOFJoint_property_angular_limit_z/restitution: - :ref:`float` **angular_limit_z/restitution** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The amount of rotational restitution across the Z axis. The lower, the more restitution occurs. @@ -546,11 +600,13 @@ The amount of rotational restitution across the Z axis. The lower, the more rest - :ref:`float` **angular_limit_z/softness** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The speed of all rotations across the Z axis. @@ -558,17 +614,23 @@ The speed of all rotations across the Z axis. - :ref:`float` **angular_limit_z/upper_angle** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The minimum rotation in positive direction to break loose and rotate around the Z axis. .. _class_Generic6DOFJoint_property_angular_motor_x/enabled: - :ref:`bool` **angular_motor_x/enabled** -+----------+-------------------+ -| *Setter* | set_flag_x(value) | -+----------+-------------------+ -| *Getter* | get_flag_x() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_x(value) | ++-----------+-------------------+ +| *Getter* | get_flag_x() | ++-----------+-------------------+ If ``true``, a rotating motor at the X axis is enabled. @@ -576,11 +638,13 @@ If ``true``, a rotating motor at the X axis is enabled. - :ref:`float` **angular_motor_x/force_limit** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 300.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ Maximum acceleration for the motor at the X axis. @@ -588,11 +652,13 @@ Maximum acceleration for the motor at the X axis. - :ref:`float` **angular_motor_x/target_velocity** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ Target speed for the motor at the X axis. @@ -600,11 +666,13 @@ Target speed for the motor at the X axis. - :ref:`bool` **angular_motor_y/enabled** -+----------+-------------------+ -| *Setter* | set_flag_y(value) | -+----------+-------------------+ -| *Getter* | get_flag_y() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_y(value) | ++-----------+-------------------+ +| *Getter* | get_flag_y() | ++-----------+-------------------+ If ``true``, a rotating motor at the Y axis is enabled. @@ -612,11 +680,13 @@ If ``true``, a rotating motor at the Y axis is enabled. - :ref:`float` **angular_motor_y/force_limit** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 300.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ Maximum acceleration for the motor at the Y axis. @@ -624,11 +694,13 @@ Maximum acceleration for the motor at the Y axis. - :ref:`float` **angular_motor_y/target_velocity** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ Target speed for the motor at the Y axis. @@ -636,11 +708,13 @@ Target speed for the motor at the Y axis. - :ref:`bool` **angular_motor_z/enabled** -+----------+-------------------+ -| *Setter* | set_flag_z(value) | -+----------+-------------------+ -| *Getter* | get_flag_z() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_z(value) | ++-----------+-------------------+ +| *Getter* | get_flag_z() | ++-----------+-------------------+ If ``true``, a rotating motor at the Z axis is enabled. @@ -648,11 +722,13 @@ If ``true``, a rotating motor at the Z axis is enabled. - :ref:`float` **angular_motor_z/force_limit** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 300.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ Maximum acceleration for the motor at the Z axis. @@ -660,11 +736,13 @@ Maximum acceleration for the motor at the Z axis. - :ref:`float` **angular_motor_z/target_velocity** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ Target speed for the motor at the Z axis. @@ -672,131 +750,157 @@ Target speed for the motor at the Z axis. - :ref:`float` **angular_spring_x/damping** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_angular_spring_x/enabled: - :ref:`bool` **angular_spring_x/enabled** -+----------+-------------------+ -| *Setter* | set_flag_x(value) | -+----------+-------------------+ -| *Getter* | get_flag_x() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_x(value) | ++-----------+-------------------+ +| *Getter* | get_flag_x() | ++-----------+-------------------+ .. _class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point: - :ref:`float` **angular_spring_x/equilibrium_point** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_angular_spring_x/stiffness: - :ref:`float` **angular_spring_x/stiffness** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_angular_spring_y/damping: - :ref:`float` **angular_spring_y/damping** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_angular_spring_y/enabled: - :ref:`bool` **angular_spring_y/enabled** -+----------+-------------------+ -| *Setter* | set_flag_y(value) | -+----------+-------------------+ -| *Getter* | get_flag_y() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_y(value) | ++-----------+-------------------+ +| *Getter* | get_flag_y() | ++-----------+-------------------+ .. _class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point: - :ref:`float` **angular_spring_y/equilibrium_point** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_angular_spring_y/stiffness: - :ref:`float` **angular_spring_y/stiffness** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_angular_spring_z/damping: - :ref:`float` **angular_spring_z/damping** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_angular_spring_z/enabled: - :ref:`bool` **angular_spring_z/enabled** -+----------+-------------------+ -| *Setter* | set_flag_z(value) | -+----------+-------------------+ -| *Getter* | get_flag_z() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_z(value) | ++-----------+-------------------+ +| *Getter* | get_flag_z() | ++-----------+-------------------+ .. _class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point: - :ref:`float` **angular_spring_z/equilibrium_point** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_angular_spring_z/stiffness: - :ref:`float` **angular_spring_z/stiffness** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_limit_x/damping: - :ref:`float` **linear_limit_x/damping** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The amount of damping that happens at the X motion. @@ -804,11 +908,13 @@ The amount of damping that happens at the X motion. - :ref:`bool` **linear_limit_x/enabled** -+----------+-------------------+ -| *Setter* | set_flag_x(value) | -+----------+-------------------+ -| *Getter* | get_flag_x() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_flag_x(value) | ++-----------+-------------------+ +| *Getter* | get_flag_x() | ++-----------+-------------------+ If ``true``, the linear motion across the X axis is limited. @@ -816,11 +922,13 @@ If ``true``, the linear motion across the X axis is limited. - :ref:`float` **linear_limit_x/lower_distance** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The minimum difference between the pivot points' X axis. @@ -828,11 +936,13 @@ The minimum difference between the pivot points' X axis. - :ref:`float` **linear_limit_x/restitution** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The amount of restitution on the X axis movement. The lower, the more momentum gets lost. @@ -840,11 +950,13 @@ The amount of restitution on the X axis movement. The lower, the more momentum g - :ref:`float` **linear_limit_x/softness** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.7 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ A factor applied to the movement across the X axis. The lower, the slower the movement. @@ -852,11 +964,13 @@ A factor applied to the movement across the X axis. The lower, the slower the mo - :ref:`float` **linear_limit_x/upper_distance** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The maximum difference between the pivot points' X axis. @@ -864,11 +978,13 @@ The maximum difference between the pivot points' X axis. - :ref:`float` **linear_limit_y/damping** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The amount of damping that happens at the Y motion. @@ -876,11 +992,13 @@ The amount of damping that happens at the Y motion. - :ref:`bool` **linear_limit_y/enabled** -+----------+-------------------+ -| *Setter* | set_flag_y(value) | -+----------+-------------------+ -| *Getter* | get_flag_y() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_flag_y(value) | ++-----------+-------------------+ +| *Getter* | get_flag_y() | ++-----------+-------------------+ If ``true``, the linear motion across the Y axis is limited. @@ -888,11 +1006,13 @@ If ``true``, the linear motion across the Y axis is limited. - :ref:`float` **linear_limit_y/lower_distance** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The minimum difference between the pivot points' Y axis. @@ -900,11 +1020,13 @@ The minimum difference between the pivot points' Y axis. - :ref:`float` **linear_limit_y/restitution** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The amount of restitution on the Y axis movement. The lower, the more momentum gets lost. @@ -912,11 +1034,13 @@ The amount of restitution on the Y axis movement. The lower, the more momentum g - :ref:`float` **linear_limit_y/softness** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.7 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ A factor applied to the movement across the Y axis. The lower, the slower the movement. @@ -924,11 +1048,13 @@ A factor applied to the movement across the Y axis. The lower, the slower the mo - :ref:`float` **linear_limit_y/upper_distance** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The maximum difference between the pivot points' Y axis. @@ -936,11 +1062,13 @@ The maximum difference between the pivot points' Y axis. - :ref:`float` **linear_limit_z/damping** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The amount of damping that happens at the Z motion. @@ -948,11 +1076,13 @@ The amount of damping that happens at the Z motion. - :ref:`bool` **linear_limit_z/enabled** -+----------+-------------------+ -| *Setter* | set_flag_z(value) | -+----------+-------------------+ -| *Getter* | get_flag_z() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_flag_z(value) | ++-----------+-------------------+ +| *Getter* | get_flag_z() | ++-----------+-------------------+ If ``true``, the linear motion across the Z axis is limited. @@ -960,11 +1090,13 @@ If ``true``, the linear motion across the Z axis is limited. - :ref:`float` **linear_limit_z/lower_distance** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The minimum difference between the pivot points' Z axis. @@ -972,11 +1104,13 @@ The minimum difference between the pivot points' Z axis. - :ref:`float` **linear_limit_z/restitution** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.5 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The amount of restitution on the Z axis movement. The lower, the more momentum gets lost. @@ -984,11 +1118,13 @@ The amount of restitution on the Z axis movement. The lower, the more momentum g - :ref:`float` **linear_limit_z/softness** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.7 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ A factor applied to the movement across the Z axis. The lower, the slower the movement. @@ -996,11 +1132,13 @@ A factor applied to the movement across the Z axis. The lower, the slower the mo - :ref:`float` **linear_limit_z/upper_distance** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The maximum difference between the pivot points' Z axis. @@ -1008,11 +1146,13 @@ The maximum difference between the pivot points' Z axis. - :ref:`bool` **linear_motor_x/enabled** -+----------+-------------------+ -| *Setter* | set_flag_x(value) | -+----------+-------------------+ -| *Getter* | get_flag_x() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_x(value) | ++-----------+-------------------+ +| *Getter* | get_flag_x() | ++-----------+-------------------+ If ``true``, then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits. @@ -1020,11 +1160,13 @@ If ``true``, then there is a linear motor on the X axis. It will attempt to reac - :ref:`float` **linear_motor_x/force_limit** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The maximum force the linear motor can apply on the X axis while trying to reach the target velocity. @@ -1032,11 +1174,13 @@ The maximum force the linear motor can apply on the X axis while trying to reach - :ref:`float` **linear_motor_x/target_velocity** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ The speed that the linear motor will attempt to reach on the X axis. @@ -1044,11 +1188,13 @@ The speed that the linear motor will attempt to reach on the X axis. - :ref:`bool` **linear_motor_y/enabled** -+----------+-------------------+ -| *Setter* | set_flag_y(value) | -+----------+-------------------+ -| *Getter* | get_flag_y() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_y(value) | ++-----------+-------------------+ +| *Getter* | get_flag_y() | ++-----------+-------------------+ If ``true``, then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits. @@ -1056,11 +1202,13 @@ If ``true``, then there is a linear motor on the Y axis. It will attempt to reac - :ref:`float` **linear_motor_y/force_limit** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity. @@ -1068,11 +1216,13 @@ The maximum force the linear motor can apply on the Y axis while trying to reach - :ref:`float` **linear_motor_y/target_velocity** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ The speed that the linear motor will attempt to reach on the Y axis. @@ -1080,11 +1230,13 @@ The speed that the linear motor will attempt to reach on the Y axis. - :ref:`bool` **linear_motor_z/enabled** -+----------+-------------------+ -| *Setter* | set_flag_z(value) | -+----------+-------------------+ -| *Getter* | get_flag_z() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_z(value) | ++-----------+-------------------+ +| *Getter* | get_flag_z() | ++-----------+-------------------+ If ``true``, then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits. @@ -1092,11 +1244,13 @@ If ``true``, then there is a linear motor on the Z axis. It will attempt to reac - :ref:`float` **linear_motor_z/force_limit** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity. @@ -1104,11 +1258,13 @@ The maximum force the linear motor can apply on the Z axis while trying to reach - :ref:`float` **linear_motor_z/target_velocity** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ The speed that the linear motor will attempt to reach on the Z axis. @@ -1116,129 +1272,155 @@ The speed that the linear motor will attempt to reach on the Z axis. - :ref:`float` **linear_spring_x/damping** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.01 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_spring_x/enabled: - :ref:`bool` **linear_spring_x/enabled** -+----------+-------------------+ -| *Setter* | set_flag_x(value) | -+----------+-------------------+ -| *Getter* | get_flag_x() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_x(value) | ++-----------+-------------------+ +| *Getter* | get_flag_x() | ++-----------+-------------------+ .. _class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point: - :ref:`float` **linear_spring_x/equilibrium_point** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_spring_x/stiffness: - :ref:`float` **linear_spring_x/stiffness** -+----------+--------------------+ -| *Setter* | set_param_x(value) | -+----------+--------------------+ -| *Getter* | get_param_x() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.01 | ++-----------+--------------------+ +| *Setter* | set_param_x(value) | ++-----------+--------------------+ +| *Getter* | get_param_x() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_spring_y/damping: - :ref:`float` **linear_spring_y/damping** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.01 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_spring_y/enabled: - :ref:`bool` **linear_spring_y/enabled** -+----------+-------------------+ -| *Setter* | set_flag_y(value) | -+----------+-------------------+ -| *Getter* | get_flag_y() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_y(value) | ++-----------+-------------------+ +| *Getter* | get_flag_y() | ++-----------+-------------------+ .. _class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point: - :ref:`float` **linear_spring_y/equilibrium_point** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_spring_y/stiffness: - :ref:`float` **linear_spring_y/stiffness** -+----------+--------------------+ -| *Setter* | set_param_y(value) | -+----------+--------------------+ -| *Getter* | get_param_y() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.01 | ++-----------+--------------------+ +| *Setter* | set_param_y(value) | ++-----------+--------------------+ +| *Getter* | get_param_y() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_spring_z/damping: - :ref:`float` **linear_spring_z/damping** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.01 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_spring_z/enabled: - :ref:`bool` **linear_spring_z/enabled** -+----------+-------------------+ -| *Setter* | set_flag_z(value) | -+----------+-------------------+ -| *Getter* | get_flag_z() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_flag_z(value) | ++-----------+-------------------+ +| *Getter* | get_flag_z() | ++-----------+-------------------+ .. _class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point: - :ref:`float` **linear_spring_z/equilibrium_point** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.0 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_linear_spring_z/stiffness: - :ref:`float` **linear_spring_z/stiffness** -+----------+--------------------+ -| *Setter* | set_param_z(value) | -+----------+--------------------+ -| *Getter* | get_param_z() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0.01 | ++-----------+--------------------+ +| *Setter* | set_param_z(value) | ++-----------+--------------------+ +| *Getter* | get_param_z() | ++-----------+--------------------+ .. _class_Generic6DOFJoint_property_precision: - :ref:`int` **precision** -+----------+----------------------+ -| *Setter* | set_precision(value) | -+----------+----------------------+ -| *Getter* | get_precision() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1 | ++-----------+----------------------+ +| *Setter* | set_precision(value) | ++-----------+----------------------+ +| *Getter* | get_precision() | ++-----------+----------------------+ diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 87bdc06b8..88f80ea1a 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -21,23 +21,23 @@ Base node for geometry-based visual instances. Properties ---------- -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`ShadowCastingSetting` | :ref:`cast_shadow` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`extra_cull_margin` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lod_max_distance` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lod_max_hysteresis` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lod_min_distance` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lod_min_hysteresis` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`material_override` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_in_baked_light` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`ShadowCastingSetting` | :ref:`cast_shadow` | 1 | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`extra_cull_margin` | 0.0 | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`lod_max_distance` | 0.0 | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`lod_max_hysteresis` | 0.0 | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`lod_min_distance` | 0.0 | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`lod_min_hysteresis` | 0.0 | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`Material` | :ref:`material_override` | null | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`use_in_baked_light` | false | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+ Methods ------- @@ -103,11 +103,13 @@ Property Descriptions - :ref:`ShadowCastingSetting` **cast_shadow** -+----------+---------------------------------+ -| *Setter* | set_cast_shadows_setting(value) | -+----------+---------------------------------+ -| *Getter* | get_cast_shadows_setting() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 1 | ++-----------+---------------------------------+ +| *Setter* | set_cast_shadows_setting(value) | ++-----------+---------------------------------+ +| *Getter* | get_cast_shadows_setting() | ++-----------+---------------------------------+ The selected shadow casting flag. See :ref:`ShadowCastingSetting` for possible values. @@ -115,11 +117,13 @@ The selected shadow casting flag. See :ref:`ShadowCastingSetting` **extra_cull_margin** -+----------+------------------------------+ -| *Setter* | set_extra_cull_margin(value) | -+----------+------------------------------+ -| *Getter* | get_extra_cull_margin() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | 0.0 | ++-----------+------------------------------+ +| *Setter* | set_extra_cull_margin(value) | ++-----------+------------------------------+ +| *Getter* | get_extra_cull_margin() | ++-----------+------------------------------+ The extra distance added to the GeometryInstance's bounding box (:ref:`AABB`) to increase its cull box. @@ -127,11 +131,13 @@ The extra distance added to the GeometryInstance's bounding box (:ref:`AABB` **lod_max_distance** -+----------+-----------------------------+ -| *Setter* | set_lod_max_distance(value) | -+----------+-----------------------------+ -| *Getter* | get_lod_max_distance() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_lod_max_distance(value) | ++-----------+-----------------------------+ +| *Getter* | get_lod_max_distance() | ++-----------+-----------------------------+ The GeometryInstance's max LOD distance. @@ -139,11 +145,13 @@ The GeometryInstance's max LOD distance. - :ref:`float` **lod_max_hysteresis** -+----------+-------------------------------+ -| *Setter* | set_lod_max_hysteresis(value) | -+----------+-------------------------------+ -| *Getter* | get_lod_max_hysteresis() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------+ +| *Setter* | set_lod_max_hysteresis(value) | ++-----------+-------------------------------+ +| *Getter* | get_lod_max_hysteresis() | ++-----------+-------------------------------+ The GeometryInstance's max LOD margin. @@ -151,11 +159,13 @@ The GeometryInstance's max LOD margin. - :ref:`float` **lod_min_distance** -+----------+-----------------------------+ -| *Setter* | set_lod_min_distance(value) | -+----------+-----------------------------+ -| *Getter* | get_lod_min_distance() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_lod_min_distance(value) | ++-----------+-----------------------------+ +| *Getter* | get_lod_min_distance() | ++-----------+-----------------------------+ The GeometryInstance's min LOD distance. @@ -163,11 +173,13 @@ The GeometryInstance's min LOD distance. - :ref:`float` **lod_min_hysteresis** -+----------+-------------------------------+ -| *Setter* | set_lod_min_hysteresis(value) | -+----------+-------------------------------+ -| *Getter* | get_lod_min_hysteresis() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------+ +| *Setter* | set_lod_min_hysteresis(value) | ++-----------+-------------------------------+ +| *Getter* | get_lod_min_hysteresis() | ++-----------+-------------------------------+ The GeometryInstance's min LOD margin. @@ -175,11 +187,13 @@ The GeometryInstance's min LOD margin. - :ref:`Material` **material_override** -+----------+------------------------------+ -| *Setter* | set_material_override(value) | -+----------+------------------------------+ -| *Getter* | get_material_override() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | null | ++-----------+------------------------------+ +| *Setter* | set_material_override(value) | ++-----------+------------------------------+ +| *Getter* | get_material_override() | ++-----------+------------------------------+ The material override for the whole geometry. @@ -189,11 +203,13 @@ If there is a material in ``material_override``, it will be used instead of any - :ref:`bool` **use_in_baked_light** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ If ``true``, this GeometryInstance will be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 0b2df7dac..62b811dea 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -19,27 +19,27 @@ Brief Description Properties ---------- -+---------------------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`bias` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`compress` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`GIProbeData` | :ref:`data` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`dynamic_range` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`energy` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`extents` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`interior` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`normal_bias` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`propagation` | -+---------------------------------------+------------------------------------------------------------+ -| :ref:`Subdiv` | :ref:`subdiv` | -+---------------------------------------+------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`bias` | 1.5 | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`compress` | false | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`GIProbeData` | :ref:`data` | null | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`int` | :ref:`dynamic_range` | 4 | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`energy` | 1.0 | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`extents` | Vector3( 10, 10, 10 ) | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`interior` | false | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`normal_bias` | 0.0 | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`propagation` | 0.7 | ++---------------------------------------+------------------------------------------------------------+-----------------------+ +| :ref:`Subdiv` | :ref:`subdiv` | 1 | ++---------------------------------------+------------------------------------------------------------+-----------------------+ Methods ------- @@ -89,101 +89,121 @@ Property Descriptions - :ref:`float` **bias** -+----------+-----------------+ -| *Setter* | set_bias(value) | -+----------+-----------------+ -| *Getter* | get_bias() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 1.5 | ++-----------+-----------------+ +| *Setter* | set_bias(value) | ++-----------+-----------------+ +| *Getter* | get_bias() | ++-----------+-----------------+ .. _class_GIProbe_property_compress: - :ref:`bool` **compress** -+----------+---------------------+ -| *Setter* | set_compress(value) | -+----------+---------------------+ -| *Getter* | is_compressed() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_compress(value) | ++-----------+---------------------+ +| *Getter* | is_compressed() | ++-----------+---------------------+ .. _class_GIProbe_property_data: - :ref:`GIProbeData` **data** -+----------+-----------------------+ -| *Setter* | set_probe_data(value) | -+----------+-----------------------+ -| *Getter* | get_probe_data() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_probe_data(value) | ++-----------+-----------------------+ +| *Getter* | get_probe_data() | ++-----------+-----------------------+ .. _class_GIProbe_property_dynamic_range: - :ref:`int` **dynamic_range** -+----------+--------------------------+ -| *Setter* | set_dynamic_range(value) | -+----------+--------------------------+ -| *Getter* | get_dynamic_range() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 4 | ++-----------+--------------------------+ +| *Setter* | set_dynamic_range(value) | ++-----------+--------------------------+ +| *Getter* | get_dynamic_range() | ++-----------+--------------------------+ .. _class_GIProbe_property_energy: - :ref:`float` **energy** -+----------+-------------------+ -| *Setter* | set_energy(value) | -+----------+-------------------+ -| *Getter* | get_energy() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_energy(value) | ++-----------+-------------------+ +| *Getter* | get_energy() | ++-----------+-------------------+ .. _class_GIProbe_property_extents: - :ref:`Vector3` **extents** -+----------+--------------------+ -| *Setter* | set_extents(value) | -+----------+--------------------+ -| *Getter* | get_extents() | -+----------+--------------------+ ++-----------+-----------------------+ +| *Default* | Vector3( 10, 10, 10 ) | ++-----------+-----------------------+ +| *Setter* | set_extents(value) | ++-----------+-----------------------+ +| *Getter* | get_extents() | ++-----------+-----------------------+ .. _class_GIProbe_property_interior: - :ref:`bool` **interior** -+----------+---------------------+ -| *Setter* | set_interior(value) | -+----------+---------------------+ -| *Getter* | is_interior() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_interior(value) | ++-----------+---------------------+ +| *Getter* | is_interior() | ++-----------+---------------------+ .. _class_GIProbe_property_normal_bias: - :ref:`float` **normal_bias** -+----------+------------------------+ -| *Setter* | set_normal_bias(value) | -+----------+------------------------+ -| *Getter* | get_normal_bias() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_normal_bias(value) | ++-----------+------------------------+ +| *Getter* | get_normal_bias() | ++-----------+------------------------+ .. _class_GIProbe_property_propagation: - :ref:`float` **propagation** -+----------+------------------------+ -| *Setter* | set_propagation(value) | -+----------+------------------------+ -| *Getter* | get_propagation() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.7 | ++-----------+------------------------+ +| *Setter* | set_propagation(value) | ++-----------+------------------------+ +| *Getter* | get_propagation() | ++-----------+------------------------+ .. _class_GIProbe_property_subdiv: - :ref:`Subdiv` **subdiv** -+----------+-------------------+ -| *Setter* | set_subdiv(value) | -+----------+-------------------+ -| *Getter* | get_subdiv() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1 | ++-----------+-------------------+ +| *Setter* | set_subdiv(value) | ++-----------+-------------------+ +| *Getter* | get_subdiv() | ++-----------+-------------------+ Method Descriptions ------------------- diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 12d736a1a..2b3bcc286 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -19,29 +19,29 @@ Brief Description Properties ---------- -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`bias` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`AABB` | :ref:`bounds` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`cell_size` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`compress` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`dynamic_data` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`dynamic_range` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`energy` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`interior` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`normal_bias` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`propagation` | -+-----------------------------------------+----------------------------------------------------------------+ -| :ref:`Transform` | :ref:`to_cell_xform` | -+-----------------------------------------+----------------------------------------------------------------+ ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`bias` | 0.4 | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`AABB` | :ref:`bounds` | AABB( 0, 0, 0, 1, 1, 1 ) | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`cell_size` | 1.0 | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`bool` | :ref:`compress` | false | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`dynamic_data` | PoolIntArray( ) | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`int` | :ref:`dynamic_range` | 1 | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`energy` | 1.0 | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`bool` | :ref:`interior` | false | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`normal_bias` | 0.4 | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`propagation` | 1.0 | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`to_cell_xform` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+ Property Descriptions --------------------- @@ -50,109 +50,131 @@ Property Descriptions - :ref:`float` **bias** -+----------+-----------------+ -| *Setter* | set_bias(value) | -+----------+-----------------+ -| *Getter* | get_bias() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0.4 | ++-----------+-----------------+ +| *Setter* | set_bias(value) | ++-----------+-----------------+ +| *Getter* | get_bias() | ++-----------+-----------------+ .. _class_GIProbeData_property_bounds: - :ref:`AABB` **bounds** -+----------+-------------------+ -| *Setter* | set_bounds(value) | -+----------+-------------------+ -| *Getter* | get_bounds() | -+----------+-------------------+ ++-----------+--------------------------+ +| *Default* | AABB( 0, 0, 0, 1, 1, 1 ) | ++-----------+--------------------------+ +| *Setter* | set_bounds(value) | ++-----------+--------------------------+ +| *Getter* | get_bounds() | ++-----------+--------------------------+ .. _class_GIProbeData_property_cell_size: - :ref:`float` **cell_size** -+----------+----------------------+ -| *Setter* | set_cell_size(value) | -+----------+----------------------+ -| *Getter* | get_cell_size() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1.0 | ++-----------+----------------------+ +| *Setter* | set_cell_size(value) | ++-----------+----------------------+ +| *Getter* | get_cell_size() | ++-----------+----------------------+ .. _class_GIProbeData_property_compress: - :ref:`bool` **compress** -+----------+---------------------+ -| *Setter* | set_compress(value) | -+----------+---------------------+ -| *Getter* | is_compressed() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_compress(value) | ++-----------+---------------------+ +| *Getter* | is_compressed() | ++-----------+---------------------+ .. _class_GIProbeData_property_dynamic_data: - :ref:`PoolIntArray` **dynamic_data** -+----------+-------------------------+ -| *Setter* | set_dynamic_data(value) | -+----------+-------------------------+ -| *Getter* | get_dynamic_data() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | PoolIntArray( ) | ++-----------+-------------------------+ +| *Setter* | set_dynamic_data(value) | ++-----------+-------------------------+ +| *Getter* | get_dynamic_data() | ++-----------+-------------------------+ .. _class_GIProbeData_property_dynamic_range: - :ref:`int` **dynamic_range** -+----------+--------------------------+ -| *Setter* | set_dynamic_range(value) | -+----------+--------------------------+ -| *Getter* | get_dynamic_range() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1 | ++-----------+--------------------------+ +| *Setter* | set_dynamic_range(value) | ++-----------+--------------------------+ +| *Getter* | get_dynamic_range() | ++-----------+--------------------------+ .. _class_GIProbeData_property_energy: - :ref:`float` **energy** -+----------+-------------------+ -| *Setter* | set_energy(value) | -+----------+-------------------+ -| *Getter* | get_energy() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_energy(value) | ++-----------+-------------------+ +| *Getter* | get_energy() | ++-----------+-------------------+ .. _class_GIProbeData_property_interior: - :ref:`bool` **interior** -+----------+---------------------+ -| *Setter* | set_interior(value) | -+----------+---------------------+ -| *Getter* | is_interior() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_interior(value) | ++-----------+---------------------+ +| *Getter* | is_interior() | ++-----------+---------------------+ .. _class_GIProbeData_property_normal_bias: - :ref:`float` **normal_bias** -+----------+------------------------+ -| *Setter* | set_normal_bias(value) | -+----------+------------------------+ -| *Getter* | get_normal_bias() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.4 | ++-----------+------------------------+ +| *Setter* | set_normal_bias(value) | ++-----------+------------------------+ +| *Getter* | get_normal_bias() | ++-----------+------------------------+ .. _class_GIProbeData_property_propagation: - :ref:`float` **propagation** -+----------+------------------------+ -| *Setter* | set_propagation(value) | -+----------+------------------------+ -| *Getter* | get_propagation() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1.0 | ++-----------+------------------------+ +| *Setter* | set_propagation(value) | ++-----------+------------------------+ +| *Getter* | get_propagation() | ++-----------+------------------------+ .. _class_GIProbeData_property_to_cell_xform: - :ref:`Transform` **to_cell_xform** -+----------+--------------------------+ -| *Setter* | set_to_cell_xform(value) | -+----------+--------------------------+ -| *Getter* | get_to_cell_xform() | -+----------+--------------------------+ ++-----------+-------------------------------------------------+ +| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------+-------------------------------------------------+ +| *Setter* | set_to_cell_xform(value) | ++-----------+-------------------------------------------------+ +| *Getter* | get_to_cell_xform() | ++-----------+-------------------------------------------------+ diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index d325d2b87..ee246e6b7 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -19,11 +19,11 @@ A color interpolator resource which can be used to generate colors between user- Properties ---------- -+---------------------------------------------+-------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`colors` | -+---------------------------------------------+-------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`offsets` | -+---------------------------------------------+-------------------------------------------------+ ++---------------------------------------------+-------------------------------------------------+------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`colors` | PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 ) | ++---------------------------------------------+-------------------------------------------------+------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`offsets` | PoolRealArray( 0, 1 ) | ++---------------------------------------------+-------------------------------------------------+------------------------------------------+ Methods ------- @@ -58,11 +58,13 @@ Property Descriptions - :ref:`PoolColorArray` **colors** -+----------+-------------------+ -| *Setter* | set_colors(value) | -+----------+-------------------+ -| *Getter* | get_colors() | -+----------+-------------------+ ++-----------+------------------------------------------+ +| *Default* | PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 ) | ++-----------+------------------------------------------+ +| *Setter* | set_colors(value) | ++-----------+------------------------------------------+ +| *Getter* | get_colors() | ++-----------+------------------------------------------+ Gradient's colors returned as a :ref:`PoolColorArray`. @@ -70,11 +72,13 @@ Gradient's colors returned as a :ref:`PoolColorArray`. - :ref:`PoolRealArray` **offsets** -+----------+--------------------+ -| *Setter* | set_offsets(value) | -+----------+--------------------+ -| *Getter* | get_offsets() | -+----------+--------------------+ ++-----------+-----------------------+ +| *Default* | PoolRealArray( 0, 1 ) | ++-----------+-----------------------+ +| *Setter* | set_offsets(value) | ++-----------+-----------------------+ +| *Getter* | get_offsets() | ++-----------+-----------------------+ Gradient's offsets returned as a :ref:`PoolRealArray`. diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 802e49ebc..1d181afc8 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -19,11 +19,11 @@ Gradient-filled texture. Properties ---------- -+---------------------------------+----------------------------------------------------------+ -| :ref:`Gradient` | :ref:`gradient` | -+---------------------------------+----------------------------------------------------------+ -| :ref:`int` | :ref:`width` | -+---------------------------------+----------------------------------------------------------+ ++---------------------------------+----------------------------------------------------------+------+ +| :ref:`Gradient` | :ref:`gradient` | null | ++---------------------------------+----------------------------------------------------------+------+ +| :ref:`int` | :ref:`width` | 2048 | ++---------------------------------+----------------------------------------------------------+------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`Gradient` **gradient** -+----------+---------------------+ -| *Setter* | set_gradient(value) | -+----------+---------------------+ -| *Getter* | get_gradient() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_gradient(value) | ++-----------+---------------------+ +| *Getter* | get_gradient() | ++-----------+---------------------+ The :ref:`Gradient` that will be used to fill the texture. @@ -49,11 +51,13 @@ The :ref:`Gradient` that will be used to fill the texture. - :ref:`int` **width** -+----------+------------------+ -| *Setter* | set_width(value) | -+----------+------------------+ -| *Getter* | get_width() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 2048 | ++-----------+------------------+ +| *Setter* | set_width(value) | ++-----------+------------------+ +| *Getter* | get_width() | ++-----------+------------------+ The number of color samples that will be obtained from the :ref:`Gradient`. diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index ada47b52e..9fc6c8588 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -19,17 +19,17 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connectio Properties ---------- -+-------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`right_disconnects` | -+-------------------------------+----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_offset` | -+-------------------------------+----------------------------------------------------------------------+ -| :ref:`int` | :ref:`snap_distance` | -+-------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_snap` | -+-------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`zoom` | -+-------------------------------+----------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`right_disconnects` | false | ++-------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`scroll_offset` | Vector2( 0, 0 ) | ++-------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`snap_distance` | 20 | ++-------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`use_snap` | true | ++-------------------------------+----------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`zoom` | 1.0 | ++-------------------------------+----------------------------------------------------------------------+-----------------+ Methods ------- @@ -69,31 +69,31 @@ Methods Theme Properties ---------------- -+---------------------------------+-------------------------------+ -| :ref:`Color` | activity | -+---------------------------------+-------------------------------+ -| :ref:`int` | bezier_len_neg | -+---------------------------------+-------------------------------+ -| :ref:`int` | bezier_len_pos | -+---------------------------------+-------------------------------+ -| :ref:`StyleBox` | bg | -+---------------------------------+-------------------------------+ -| :ref:`Color` | grid_major | -+---------------------------------+-------------------------------+ -| :ref:`Color` | grid_minor | -+---------------------------------+-------------------------------+ -| :ref:`Texture` | minus | -+---------------------------------+-------------------------------+ -| :ref:`Texture` | more | -+---------------------------------+-------------------------------+ -| :ref:`int` | port_grab_distance_horizontal | -+---------------------------------+-------------------------------+ -| :ref:`int` | port_grab_distance_vertical | -+---------------------------------+-------------------------------+ -| :ref:`Texture` | reset | -+---------------------------------+-------------------------------+ -| :ref:`Texture` | snap | -+---------------------------------+-------------------------------+ ++---------------------------------+-------------------------------+------------------------+ +| :ref:`Color` | activity | Color( 1, 1, 1, 1 ) | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`int` | bezier_len_neg | 160 | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`int` | bezier_len_pos | 80 | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`StyleBox` | bg | | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`Color` | grid_major | Color( 1, 1, 1, 0.2 ) | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`Color` | grid_minor | Color( 1, 1, 1, 0.05 ) | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`Texture` | minus | | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`Texture` | more | | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`int` | port_grab_distance_horizontal | 48 | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`int` | port_grab_distance_vertical | 6 | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`Texture` | reset | | ++---------------------------------+-------------------------------+------------------------+ +| :ref:`Texture` | snap | | ++---------------------------------+-------------------------------+------------------------+ Signals ------- @@ -176,11 +176,13 @@ Property Descriptions - :ref:`bool` **right_disconnects** -+----------+--------------------------------+ -| *Setter* | set_right_disconnects(value) | -+----------+--------------------------------+ -| *Getter* | is_right_disconnects_enabled() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | false | ++-----------+--------------------------------+ +| *Setter* | set_right_disconnects(value) | ++-----------+--------------------------------+ +| *Getter* | is_right_disconnects_enabled() | ++-----------+--------------------------------+ If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end. @@ -188,11 +190,13 @@ If ``true``, enables disconnection of existing connections in the GraphEdit by d - :ref:`Vector2` **scroll_offset** -+----------+-----------------------+ -| *Setter* | set_scroll_ofs(value) | -+----------+-----------------------+ -| *Getter* | get_scroll_ofs() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------------+ +| *Setter* | set_scroll_ofs(value) | ++-----------+-----------------------+ +| *Getter* | get_scroll_ofs() | ++-----------+-----------------------+ The scroll offset. @@ -200,11 +204,13 @@ The scroll offset. - :ref:`int` **snap_distance** -+----------+-----------------+ -| *Setter* | set_snap(value) | -+----------+-----------------+ -| *Getter* | get_snap() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 20 | ++-----------+-----------------+ +| *Setter* | set_snap(value) | ++-----------+-----------------+ +| *Getter* | get_snap() | ++-----------+-----------------+ The snapping distance in pixels. @@ -212,11 +218,13 @@ The snapping distance in pixels. - :ref:`bool` **use_snap** -+----------+---------------------+ -| *Setter* | set_use_snap(value) | -+----------+---------------------+ -| *Getter* | is_using_snap() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_use_snap(value) | ++-----------+---------------------+ +| *Getter* | is_using_snap() | ++-----------+---------------------+ If ``true``, enables snapping. @@ -224,11 +232,13 @@ If ``true``, enables snapping. - :ref:`float` **zoom** -+----------+-----------------+ -| *Setter* | set_zoom(value) | -+----------+-----------------+ -| *Getter* | get_zoom() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 1.0 | ++-----------+-----------------+ +| *Setter* | set_zoom(value) | ++-----------+-----------------+ +| *Getter* | get_zoom() | ++-----------+-----------------+ The current zoom value. diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index a9d6a834b..aef1fd3eb 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -19,21 +19,21 @@ A GraphNode is a container with several input and output slots allowing connecti Properties ---------- -+----------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`comment` | -+----------------------------------------+--------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+----------------------------------------+--------------------------------------------------------+ -| :ref:`Overlay` | :ref:`overlay` | -+----------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`resizable` | -+----------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`selected` | -+----------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`show_close` | -+----------------------------------------+--------------------------------------------------------+ -| :ref:`String` | :ref:`title` | -+----------------------------------------+--------------------------------------------------------+ ++----------------------------------------+--------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`comment` | false | ++----------------------------------------+--------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++----------------------------------------+--------------------------------------------------------+-----------------+ +| :ref:`Overlay` | :ref:`overlay` | 0 | ++----------------------------------------+--------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`resizable` | false | ++----------------------------------------+--------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`selected` | false | ++----------------------------------------+--------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`show_close` | false | ++----------------------------------------+--------------------------------------------------------+-----------------+ +| :ref:`String` | :ref:`title` | "" | ++----------------------------------------+--------------------------------------------------------+-----------------+ Methods ------- @@ -77,43 +77,43 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------+ -| :ref:`StyleBox` | breakpoint | -+---------------------------------+---------------+ -| :ref:`Texture` | close | -+---------------------------------+---------------+ -| :ref:`Color` | close_color | -+---------------------------------+---------------+ -| :ref:`int` | close_offset | -+---------------------------------+---------------+ -| :ref:`StyleBox` | comment | -+---------------------------------+---------------+ -| :ref:`StyleBox` | commentfocus | -+---------------------------------+---------------+ -| :ref:`StyleBox` | defaultfocus | -+---------------------------------+---------------+ -| :ref:`StyleBox` | defaultframe | -+---------------------------------+---------------+ -| :ref:`StyleBox` | frame | -+---------------------------------+---------------+ -| :ref:`Texture` | port | -+---------------------------------+---------------+ -| :ref:`int` | port_offset | -+---------------------------------+---------------+ -| :ref:`StyleBox` | position | -+---------------------------------+---------------+ -| :ref:`Texture` | resizer | -+---------------------------------+---------------+ -| :ref:`StyleBox` | selectedframe | -+---------------------------------+---------------+ -| :ref:`int` | separation | -+---------------------------------+---------------+ -| :ref:`Color` | title_color | -+---------------------------------+---------------+ -| :ref:`Font` | title_font | -+---------------------------------+---------------+ -| :ref:`int` | title_offset | -+---------------------------------+---------------+ ++---------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | breakpoint | | ++---------------------------------+---------------+---------------------+ +| :ref:`Texture` | close | | ++---------------------------------+---------------+---------------------+ +| :ref:`Color` | close_color | Color( 0, 0, 0, 1 ) | ++---------------------------------+---------------+---------------------+ +| :ref:`int` | close_offset | 18 | ++---------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | comment | | ++---------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | commentfocus | | ++---------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | defaultfocus | | ++---------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | defaultframe | | ++---------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | frame | | ++---------------------------------+---------------+---------------------+ +| :ref:`Texture` | port | | ++---------------------------------+---------------+---------------------+ +| :ref:`int` | port_offset | 3 | ++---------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | position | | ++---------------------------------+---------------+---------------------+ +| :ref:`Texture` | resizer | | ++---------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | selectedframe | | ++---------------------------------+---------------+---------------------+ +| :ref:`int` | separation | 1 | ++---------------------------------+---------------+---------------------+ +| :ref:`Color` | title_color | Color( 0, 0, 0, 1 ) | ++---------------------------------+---------------+---------------------+ +| :ref:`Font` | title_font | | ++---------------------------------+---------------+---------------------+ +| :ref:`int` | title_offset | 20 | ++---------------------------------+---------------+---------------------+ Signals ------- @@ -177,21 +177,25 @@ Property Descriptions - :ref:`bool` **comment** -+----------+--------------------+ -| *Setter* | set_comment(value) | -+----------+--------------------+ -| *Getter* | is_comment() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_comment(value) | ++-----------+--------------------+ +| *Getter* | is_comment() | ++-----------+--------------------+ .. _class_GraphNode_property_offset: - :ref:`Vector2` **offset** -+----------+-------------------+ -| *Setter* | set_offset(value) | -+----------+-------------------+ -| *Getter* | get_offset() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------+ +| *Setter* | set_offset(value) | ++-----------+-------------------+ +| *Getter* | get_offset() | ++-----------+-------------------+ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit`. @@ -201,51 +205,61 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi - :ref:`Overlay` **overlay** -+----------+--------------------+ -| *Setter* | set_overlay(value) | -+----------+--------------------+ -| *Getter* | get_overlay() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_overlay(value) | ++-----------+--------------------+ +| *Getter* | get_overlay() | ++-----------+--------------------+ .. _class_GraphNode_property_resizable: - :ref:`bool` **resizable** -+----------+----------------------+ -| *Setter* | set_resizable(value) | -+----------+----------------------+ -| *Getter* | is_resizable() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_resizable(value) | ++-----------+----------------------+ +| *Getter* | is_resizable() | ++-----------+----------------------+ .. _class_GraphNode_property_selected: - :ref:`bool` **selected** -+----------+---------------------+ -| *Setter* | set_selected(value) | -+----------+---------------------+ -| *Getter* | is_selected() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_selected(value) | ++-----------+---------------------+ +| *Getter* | is_selected() | ++-----------+---------------------+ .. _class_GraphNode_property_show_close: - :ref:`bool` **show_close** -+----------+------------------------------+ -| *Setter* | set_show_close_button(value) | -+----------+------------------------------+ -| *Getter* | is_close_button_visible() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_show_close_button(value) | ++-----------+------------------------------+ +| *Getter* | is_close_button_visible() | ++-----------+------------------------------+ .. _class_GraphNode_property_title: - :ref:`String` **title** -+----------+------------------+ -| *Setter* | set_title(value) | -+----------+------------------+ -| *Getter* | get_title() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | "" | ++-----------+------------------+ +| *Setter* | set_title(value) | ++-----------+------------------+ +| *Getter* | get_title() | ++-----------+------------------+ Method Descriptions ------------------- diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 682b80f8b..512736bc4 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -19,18 +19,18 @@ Grid container used to arrange elements in a grid like layout. Properties ---------- -+-----------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`columns` | -+-----------------------+------------------------------------------------------+ ++-----------------------+------------------------------------------------------+---+ +| :ref:`int` | :ref:`columns` | 1 | ++-----------------------+------------------------------------------------------+---+ Theme Properties ---------------- -+-----------------------+-------------+ -| :ref:`int` | hseparation | -+-----------------------+-------------+ -| :ref:`int` | vseparation | -+-----------------------+-------------+ ++-----------------------+-------------+---+ +| :ref:`int` | hseparation | 4 | ++-----------------------+-------------+---+ +| :ref:`int` | vseparation | 4 | ++-----------------------+-------------+---+ Description ----------- @@ -44,11 +44,13 @@ Property Descriptions - :ref:`int` **columns** -+----------+--------------------+ -| *Setter* | set_columns(value) | -+----------+--------------------+ -| *Getter* | get_columns() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1 | ++-----------+--------------------+ +| *Setter* | set_columns(value) | ++-----------+--------------------+ +| *Getter* | get_columns() | ++-----------+--------------------+ The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout. diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 54f8e74c7..fe44b43e9 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -19,27 +19,27 @@ Node for 3D tile-based maps. Properties ---------- -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_center_x` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_center_y` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_center_z` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`cell_octant_size` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`cell_scale` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cell_size` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`MeshLibrary` | :ref:`mesh_library` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`MeshLibrary` | :ref:`theme` | -+---------------------------------------+------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`cell_center_x` | true | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`cell_center_y` | true | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`cell_center_z` | true | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`cell_octant_size` | 8 | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`cell_scale` | 1.0 | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`cell_size` | Vector3( 2, 2, 2 ) | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`MeshLibrary` | :ref:`mesh_library` | null | ++---------------------------------------+------------------------------------------------------------------+--------------------+ +| :ref:`MeshLibrary` | :ref:`theme` | | ++---------------------------------------+------------------------------------------------------------------+--------------------+ Methods ------- @@ -112,11 +112,13 @@ Property Descriptions - :ref:`bool` **cell_center_x** -+----------+---------------------+ -| *Setter* | set_center_x(value) | -+----------+---------------------+ -| *Getter* | get_center_x() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_center_x(value) | ++-----------+---------------------+ +| *Getter* | get_center_x() | ++-----------+---------------------+ If ``true``, grid items are centered on the X axis. @@ -124,11 +126,13 @@ If ``true``, grid items are centered on the X axis. - :ref:`bool` **cell_center_y** -+----------+---------------------+ -| *Setter* | set_center_y(value) | -+----------+---------------------+ -| *Getter* | get_center_y() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_center_y(value) | ++-----------+---------------------+ +| *Getter* | get_center_y() | ++-----------+---------------------+ If ``true``, grid items are centered on the Y axis. @@ -136,11 +140,13 @@ If ``true``, grid items are centered on the Y axis. - :ref:`bool` **cell_center_z** -+----------+---------------------+ -| *Setter* | set_center_z(value) | -+----------+---------------------+ -| *Getter* | get_center_z() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_center_z(value) | ++-----------+---------------------+ +| *Getter* | get_center_z() | ++-----------+---------------------+ If ``true``, grid items are centered on the Z axis. @@ -148,11 +154,13 @@ If ``true``, grid items are centered on the Z axis. - :ref:`int` **cell_octant_size** -+----------+------------------------+ -| *Setter* | set_octant_size(value) | -+----------+------------------------+ -| *Getter* | get_octant_size() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 8 | ++-----------+------------------------+ +| *Setter* | set_octant_size(value) | ++-----------+------------------------+ +| *Getter* | get_octant_size() | ++-----------+------------------------+ The size of each octant measured in number of cells. This applies to all three axis. @@ -160,21 +168,25 @@ The size of each octant measured in number of cells. This applies to all three a - :ref:`float` **cell_scale** -+----------+-----------------------+ -| *Setter* | set_cell_scale(value) | -+----------+-----------------------+ -| *Getter* | get_cell_scale() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_cell_scale(value) | ++-----------+-----------------------+ +| *Getter* | get_cell_scale() | ++-----------+-----------------------+ .. _class_GridMap_property_cell_size: - :ref:`Vector3` **cell_size** -+----------+----------------------+ -| *Setter* | set_cell_size(value) | -+----------+----------------------+ -| *Getter* | get_cell_size() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Vector3( 2, 2, 2 ) | ++-----------+----------------------+ +| *Setter* | set_cell_size(value) | ++-----------+----------------------+ +| *Getter* | get_cell_size() | ++-----------+----------------------+ The dimensions of the grid's cells. @@ -182,31 +194,37 @@ The dimensions of the grid's cells. - :ref:`int` **collision_layer** -+----------+----------------------------+ -| *Setter* | set_collision_layer(value) | -+----------+----------------------------+ -| *Getter* | get_collision_layer() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1 | ++-----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++-----------+----------------------------+ +| *Getter* | get_collision_layer() | ++-----------+----------------------------+ .. _class_GridMap_property_collision_mask: - :ref:`int` **collision_mask** -+----------+---------------------------+ -| *Setter* | set_collision_mask(value) | -+----------+---------------------------+ -| *Getter* | get_collision_mask() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_collision_mask() | ++-----------+---------------------------+ .. _class_GridMap_property_mesh_library: - :ref:`MeshLibrary` **mesh_library** -+----------+-------------------------+ -| *Setter* | set_mesh_library(value) | -+----------+-------------------------+ -| *Getter* | get_mesh_library() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | null | ++-----------+-------------------------+ +| *Setter* | set_mesh_library(value) | ++-----------+-------------------------+ +| *Getter* | get_mesh_library() | ++-----------+-------------------------+ The assigned :ref:`MeshLibrary`. diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index e4bfb11bb..ffae8d5d7 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -19,11 +19,11 @@ Groove constraint for 2D physics. Properties ---------- -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_offset` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+--------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`initial_offset` | 25.0 | ++---------------------------+--------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`length` | 50.0 | ++---------------------------+--------------------------------------------------------------------+------+ Description ----------- @@ -37,23 +37,27 @@ Property Descriptions - :ref:`float` **initial_offset** -+----------+---------------------------+ -| *Setter* | set_initial_offset(value) | -+----------+---------------------------+ -| *Getter* | get_initial_offset() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 25.0 | ++-----------+---------------------------+ +| *Setter* | set_initial_offset(value) | ++-----------+---------------------------+ +| *Getter* | get_initial_offset() | ++-----------+---------------------------+ -The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset` along the joint's Y axis (along the groove). Default value: ``25``. +The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset` along the joint's Y axis (along the groove). .. _class_GrooveJoint2D_property_length: - :ref:`float` **length** -+----------+-------------------+ -| *Setter* | set_length(value) | -+----------+-------------------+ -| *Getter* | get_length() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 50.0 | ++-----------+-------------------+ +| *Setter* | set_length(value) | ++-----------+-------------------+ +| *Getter* | get_length() | ++-----------+-------------------+ -The groove's length. The groove is from the joint's origin towards :ref:`length` along the joint's local Y axis. Default value: ``50``. +The groove's length. The groove is from the joint's origin towards :ref:`length` along the joint's local Y axis. diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index 6b39c6a68..afea95281 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -19,9 +19,9 @@ Horizontal box container. Theme Properties ---------------- -+-----------------------+------------+ -| :ref:`int` | separation | -+-----------------------+------------+ ++-----------------------+------------+---+ +| :ref:`int` | separation | 4 | ++-----------------------+------------+---+ Description ----------- diff --git a/classes/class_heightmapshape.rst b/classes/class_heightmapshape.rst index 4a0f8c046..6acdcea9e 100644 --- a/classes/class_heightmapshape.rst +++ b/classes/class_heightmapshape.rst @@ -19,13 +19,13 @@ Height map shape for 3D physics (Bullet only). Properties ---------- -+-------------------------------------------+-----------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`map_data` | -+-------------------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`map_depth` | -+-------------------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`map_width` | -+-------------------------------------------+-----------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------+-----------------------------+ +| :ref:`PoolRealArray` | :ref:`map_data` | PoolRealArray( 0, 0, 0, 0 ) | ++-------------------------------------------+-----------------------------------------------------------+-----------------------------+ +| :ref:`int` | :ref:`map_depth` | 2 | ++-------------------------------------------+-----------------------------------------------------------+-----------------------------+ +| :ref:`int` | :ref:`map_width` | 2 | ++-------------------------------------------+-----------------------------------------------------------+-----------------------------+ Description ----------- @@ -39,11 +39,13 @@ Property Descriptions - :ref:`PoolRealArray` **map_data** -+----------+---------------------+ -| *Setter* | set_map_data(value) | -+----------+---------------------+ -| *Getter* | get_map_data() | -+----------+---------------------+ ++-----------+-----------------------------+ +| *Default* | PoolRealArray( 0, 0, 0, 0 ) | ++-----------+-----------------------------+ +| *Setter* | set_map_data(value) | ++-----------+-----------------------------+ +| *Getter* | get_map_data() | ++-----------+-----------------------------+ Height map data, pool array must be of :ref:`map_width` \* :ref:`map_depth` size. @@ -51,11 +53,13 @@ Height map data, pool array must be of :ref:`map_width` **map_depth** -+----------+----------------------+ -| *Setter* | set_map_depth(value) | -+----------+----------------------+ -| *Getter* | get_map_depth() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 2 | ++-----------+----------------------+ +| *Setter* | set_map_depth(value) | ++-----------+----------------------+ +| *Getter* | get_map_depth() | ++-----------+----------------------+ Depth of the height map data. Changing this will resize the :ref:`map_data`. @@ -63,11 +67,13 @@ Depth of the height map data. Changing this will resize the :ref:`map_data` **map_width** -+----------+----------------------+ -| *Setter* | set_map_width(value) | -+----------+----------------------+ -| *Getter* | get_map_width() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 2 | ++-----------+----------------------+ +| *Setter* | set_map_width(value) | ++-----------+----------------------+ +| *Getter* | get_map_width() | ++-----------+----------------------+ Width of the height map data. Changing this will resize the :ref:`map_data`. diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index dc79345cc..cf876921a 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -19,27 +19,27 @@ A hinge between two 3D bodies. Properties ---------- -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/bias` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_limit/enable` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/lower` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/relaxation` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/softness` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/upper` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`motor/enable` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`motor/max_impulse` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`motor/target_velocity` | -+---------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params/bias` | -+---------------------------+-------------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit/bias` | 0.3 | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`angular_limit/enable` | false | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit/lower` | -90.0 | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit/relaxation` | 1.0 | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit/softness` | 0.9 | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`angular_limit/upper` | 90.0 | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`motor/enable` | false | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`motor/max_impulse` | 1.0 | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`motor/target_velocity` | 1.0 | ++---------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`params/bias` | 0.3 | ++---------------------------+-------------------------------------------------------------------------------------+-------+ Enumerations ------------ @@ -112,11 +112,13 @@ Property Descriptions - :ref:`float` **angular_limit/bias** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.3 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The speed with which the rotation across the axis perpendicular to the hinge gets corrected. @@ -124,11 +126,13 @@ The speed with which the rotation across the axis perpendicular to the hinge get - :ref:`bool` **angular_limit/enable** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. @@ -136,17 +140,23 @@ If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_l - :ref:`float` **angular_limit/lower** ++-----------+-------+ +| *Default* | -90.0 | ++-----------+-------+ + The minimum rotation. Only active if :ref:`angular_limit/enable` is ``true``. .. _class_HingeJoint_property_angular_limit/relaxation: - :ref:`float` **angular_limit/relaxation** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The lower this value, the more the rotation gets slowed down. @@ -154,27 +164,35 @@ The lower this value, the more the rotation gets slowed down. - :ref:`float` **angular_limit/softness** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.9 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ .. _class_HingeJoint_property_angular_limit/upper: - :ref:`float` **angular_limit/upper** ++-----------+------+ +| *Default* | 90.0 | ++-----------+------+ + The maximum rotation. Only active if :ref:`angular_limit/enable` is ``true``. .. _class_HingeJoint_property_motor/enable: - :ref:`bool` **motor/enable** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ When activated, a motor turns the hinge. @@ -182,11 +200,13 @@ When activated, a motor turns the hinge. - :ref:`float` **motor/max_impulse** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Maximum acceleration for the motor. @@ -194,11 +214,13 @@ Maximum acceleration for the motor. - :ref:`float` **motor/target_velocity** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Target speed for the motor. @@ -206,11 +228,13 @@ Target speed for the motor. - :ref:`float` **params/bias** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.3 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The speed with which the two bodies get pulled together when they move in different directions. diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index ed62446aa..c0c6a9387 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -19,11 +19,11 @@ Horizontal separator. Theme Properties ---------------- -+---------------------------------+------------+ -| :ref:`int` | separation | -+---------------------------------+------------+ -| :ref:`StyleBox` | separator | -+---------------------------------+------------+ ++---------------------------------+------------+---+ +| :ref:`int` | separation | 4 | ++---------------------------------+------------+---+ +| :ref:`StyleBox` | separator | | ++---------------------------------+------------+---+ Description ----------- diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index cacbd858e..42cb42db0 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -19,15 +19,15 @@ Horizontal split container. Theme Properties ---------------- -+---------------------------------+------------+ -| :ref:`int` | autohide | -+---------------------------------+------------+ -| :ref:`StyleBox` | bg | -+---------------------------------+------------+ -| :ref:`Texture` | grabber | -+---------------------------------+------------+ -| :ref:`int` | separation | -+---------------------------------+------------+ ++---------------------------------+------------+----+ +| :ref:`int` | autohide | 1 | ++---------------------------------+------------+----+ +| :ref:`StyleBox` | bg | | ++---------------------------------+------------+----+ +| :ref:`Texture` | grabber | | ++---------------------------------+------------+----+ +| :ref:`int` | separation | 12 | ++---------------------------------+------------+----+ Description ----------- diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index a0353e864..08a8deb85 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -19,11 +19,11 @@ Hyper-text transfer protocol client. Properties ---------- -+-------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`blocking_mode_enabled` | -+-------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`StreamPeer` | :ref:`connection` | -+-------------------------------------+-------------------------------------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`blocking_mode_enabled` | false | ++-------------------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`StreamPeer` | :ref:`connection` | | ++-------------------------------------+-------------------------------------------------------------------------------+-------+ Methods ------- @@ -424,11 +424,13 @@ Property Descriptions - :ref:`bool` **blocking_mode_enabled** -+----------+----------------------------+ -| *Setter* | set_blocking_mode(value) | -+----------+----------------------------+ -| *Getter* | is_blocking_mode_enabled() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | false | ++-----------+----------------------------+ +| *Setter* | set_blocking_mode(value) | ++-----------+----------------------------+ +| *Getter* | is_blocking_mode_enabled() | ++-----------+----------------------------+ If ``true``, execution will block until all data is read from the response. diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index bfb7cd536..bf59b7eec 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -19,15 +19,15 @@ A node with the ability to send HTTP requests. Properties ---------- -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_size_limit` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`download_file` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_redirects` | -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_threads` | -+-----------------------------+--------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`body_size_limit` | -1 | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`download_file` | "" | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`max_redirects` | 8 | ++-----------------------------+--------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`use_threads` | false | ++-----------------------------+--------------------------------------------------------------------+-------+ Methods ------- @@ -127,11 +127,13 @@ Property Descriptions - :ref:`int` **body_size_limit** -+----------+----------------------------+ -| *Setter* | set_body_size_limit(value) | -+----------+----------------------------+ -| *Getter* | get_body_size_limit() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | -1 | ++-----------+----------------------------+ +| *Setter* | set_body_size_limit(value) | ++-----------+----------------------------+ +| *Getter* | get_body_size_limit() | ++-----------+----------------------------+ Maximum allowed size for response bodies. @@ -139,11 +141,13 @@ Maximum allowed size for response bodies. - :ref:`String` **download_file** -+----------+--------------------------+ -| *Setter* | set_download_file(value) | -+----------+--------------------------+ -| *Getter* | get_download_file() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | "" | ++-----------+--------------------------+ +| *Setter* | set_download_file(value) | ++-----------+--------------------------+ +| *Getter* | get_download_file() | ++-----------+--------------------------+ The file to download into. Will output any received file into it. @@ -151,11 +155,13 @@ The file to download into. Will output any received file into it. - :ref:`int` **max_redirects** -+----------+--------------------------+ -| *Setter* | set_max_redirects(value) | -+----------+--------------------------+ -| *Getter* | get_max_redirects() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 8 | ++-----------+--------------------------+ +| *Setter* | set_max_redirects(value) | ++-----------+--------------------------+ +| *Getter* | get_max_redirects() | ++-----------+--------------------------+ Maximum number of allowed redirects. @@ -163,11 +169,13 @@ Maximum number of allowed redirects. - :ref:`bool` **use_threads** -+----------+------------------------+ -| *Setter* | set_use_threads(value) | -+----------+------------------------+ -| *Getter* | is_using_threads() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_use_threads(value) | ++-----------+------------------------+ +| *Getter* | is_using_threads() | ++-----------+------------------------+ If ``true``, multithreading is used to improve performance. diff --git a/classes/class_image.rst b/classes/class_image.rst index baf5a5739..2cda0f44c 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -19,9 +19,9 @@ Image datatype. Properties ---------- -+-------------------------------------+----------------------------------------+ -| :ref:`Dictionary` | :ref:`data` | -+-------------------------------------+----------------------------------------+ ++-------------------------------------+----------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`data` | { "data": PoolByteArray( ), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 } | ++-------------------------------------+----------------------------------------+--------------------------------------------------------------------------------------------+ Methods ------- @@ -418,6 +418,10 @@ Property Descriptions - :ref:`Dictionary` **data** ++-----------+--------------------------------------------------------------------------------------------+ +| *Default* | { "data": PoolByteArray( ), "format": "Lum8", "height": 0, "mipmaps": false, "width": 0 } | ++-----------+--------------------------------------------------------------------------------------------+ + Holds all of the image's color data in a given format. See ``FORMAT_*`` constants. Method Descriptions diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 829d2a0e8..154a6488a 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -19,11 +19,11 @@ A :ref:`Texture` based on an :ref:`Image`. Properties ---------- -+-------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`lossy_quality` | -+-------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Storage` | :ref:`storage` | -+-------------------------------------------+-----------------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`lossy_quality` | 0.7 | ++-------------------------------------------+-----------------------------------------------------------------+-----+ +| :ref:`Storage` | :ref:`storage` | 0 | ++-------------------------------------------+-----------------------------------------------------------------+-----+ Methods ------- @@ -73,11 +73,13 @@ Property Descriptions - :ref:`float` **lossy_quality** -+----------+----------------------------------+ -| *Setter* | set_lossy_storage_quality(value) | -+----------+----------------------------------+ -| *Getter* | get_lossy_storage_quality() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 0.7 | ++-----------+----------------------------------+ +| *Setter* | set_lossy_storage_quality(value) | ++-----------+----------------------------------+ +| *Getter* | get_lossy_storage_quality() | ++-----------+----------------------------------+ The storage quality for :ref:`STORAGE_COMPRESS_LOSSY`. @@ -85,11 +87,13 @@ The storage quality for :ref:`STORAGE_COMPRESS_LOSSY` **storage** -+----------+--------------------+ -| *Setter* | set_storage(value) | -+----------+--------------------+ -| *Getter* | get_storage() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_storage(value) | ++-----------+--------------------+ +| *Getter* | get_storage() | ++-----------+--------------------+ The storage type (raw, lossy, or compressed). diff --git a/classes/class_input.rst b/classes/class_input.rst index 23390317f..857333308 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -440,7 +440,7 @@ Sets the mouse mode. See the constants for more information. - void **set_use_accumulated_input** **(** :ref:`bool` enable **)** -Whether to accumulate similar input events sent by the operating system. Defaults to ``true``. +Whether to accumulate similar input events sent by the operating system. Enabled by default. .. _class_Input_method_start_joy_vibration: diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index f56b02665..a8735488a 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -21,9 +21,9 @@ Generic input event Properties ---------- -+-----------------------+-------------------------------------------------+ -| :ref:`int` | :ref:`device` | -+-----------------------+-------------------------------------------------+ ++-----------------------+-------------------------------------------------+---+ +| :ref:`int` | :ref:`device` | 0 | ++-----------------------+-------------------------------------------------+---+ Methods ------- @@ -71,11 +71,13 @@ Property Descriptions - :ref:`int` **device** -+----------+-------------------+ -| *Setter* | set_device(value) | -+----------+-------------------+ -| *Getter* | get_device() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0 | ++-----------+-------------------+ +| *Setter* | set_device(value) | ++-----------+-------------------+ +| *Getter* | get_device() | ++-----------+-------------------+ The event's device ID. diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index a63db5bd7..ef5377b6a 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -19,13 +19,13 @@ Input event type for actions. Properties ---------- -+-----------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`action` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`strength` | -+-----------------------------+-----------------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`String` | :ref:`action` | "" | ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`pressed` | false | ++-----------------------------+-----------------------------------------------------------+-------+ +| :ref:`float` | :ref:`strength` | 1.0 | ++-----------------------------+-----------------------------------------------------------+-------+ Description ----------- @@ -44,11 +44,13 @@ Property Descriptions - :ref:`String` **action** -+----------+-------------------+ -| *Setter* | set_action(value) | -+----------+-------------------+ -| *Getter* | get_action() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | "" | ++-----------+-------------------+ +| *Setter* | set_action(value) | ++-----------+-------------------+ +| *Getter* | get_action() | ++-----------+-------------------+ The action's name. Actions are accessed via this :ref:`String`. @@ -56,11 +58,13 @@ The action's name. Actions are accessed via this :ref:`String`. - :ref:`bool` **pressed** -+----------+--------------------+ -| *Setter* | set_pressed(value) | -+----------+--------------------+ -| *Getter* | is_pressed() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_pressed(value) | ++-----------+--------------------+ +| *Getter* | is_pressed() | ++-----------+--------------------+ If ``true``, the action's state is pressed. If ``false``, the action's state is released. @@ -68,11 +72,13 @@ If ``true``, the action's state is pressed. If ``false``, the action's state is - :ref:`float` **strength** -+----------+---------------------+ -| *Setter* | set_strength(value) | -+----------+---------------------+ -| *Getter* | get_strength() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 1.0 | ++-----------+---------------------+ +| *Setter* | set_strength(value) | ++-----------+---------------------+ +| *Getter* | get_strength() | ++-----------+---------------------+ The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is ``false``. The event strength allows faking analog joypad motion events, by precising how strongly is the joypad axis bent or pressed. diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 2d7267b11..c54c31511 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -21,9 +21,9 @@ Brief Description Properties ---------- -+-------------------------------+------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`position` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------------------+-----------------+ Property Descriptions --------------------- @@ -32,9 +32,11 @@ Property Descriptions - :ref:`Vector2` **position** -+----------+---------------------+ -| *Setter* | set_position(value) | -+----------+---------------------+ -| *Getter* | get_position() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_position(value) | ++-----------+---------------------+ +| *Getter* | get_position() | ++-----------+---------------------+ diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index b840b6af6..99210457c 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -19,13 +19,13 @@ Input event for gamepad buttons. Properties ---------- -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`int` | :ref:`button_index` | -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pressure` | -+---------------------------+-------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`button_index` | 0 | ++---------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`pressed` | false | ++---------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`pressure` | 0.0 | ++---------------------------+-------------------------------------------------------------------------+-------+ Description ----------- @@ -44,11 +44,13 @@ Property Descriptions - :ref:`int` **button_index** -+----------+-------------------------+ -| *Setter* | set_button_index(value) | -+----------+-------------------------+ -| *Getter* | get_button_index() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_button_index(value) | ++-----------+-------------------------+ +| *Getter* | get_button_index() | ++-----------+-------------------------+ Button identifier. One of the :ref:`JoystickList` button constants. @@ -56,11 +58,13 @@ Button identifier. One of the :ref:`JoystickList - :ref:`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. If ``false``, the button's state is released. @@ -68,11 +72,13 @@ If ``true``, the button's state is pressed. If ``false``, the button's state is - :ref:`float` **pressure** -+----------+---------------------+ -| *Setter* | set_pressure(value) | -+----------+---------------------+ -| *Getter* | get_pressure() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_pressure(value) | ++-----------+---------------------+ +| *Getter* | get_pressure() | ++-----------+---------------------+ Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``. diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 3e0666485..49296a127 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -19,11 +19,11 @@ Input event type for gamepad joysticks and other motions. For buttons, see ``Inp Properties ---------- -+---------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`axis` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`axis_value` | -+---------------------------+---------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------+-----+ +| :ref:`int` | :ref:`axis` | 0 | ++---------------------------+---------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`axis_value` | 0.0 | ++---------------------------+---------------------------------------------------------------------+-----+ Description ----------- @@ -42,11 +42,13 @@ Property Descriptions - :ref:`int` **axis** -+----------+-----------------+ -| *Setter* | set_axis(value) | -+----------+-----------------+ -| *Getter* | get_axis() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_axis(value) | ++-----------+-----------------+ +| *Getter* | get_axis() | ++-----------+-----------------+ Axis identifier. Use one of the :ref:`JoystickList` axis constants. @@ -54,11 +56,13 @@ Axis identifier. Use one of the :ref:`JoystickList` **axis_value** -+----------+-----------------------+ -| *Setter* | set_axis_value(value) | -+----------+-----------------------+ -| *Getter* | get_axis_value() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0.0 | ++-----------+-----------------------+ +| *Setter* | set_axis_value(value) | ++-----------+-----------------------+ +| *Getter* | get_axis_value() | ++-----------+-----------------------+ Current position of the joystick on the given axis. The value ranges from ``-1.0`` to ``1.0``. A value of ``0`` means the axis is in its resting position. diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index ce8435eb9..a93e64fac 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -19,15 +19,15 @@ Input event type for keyboard events. Properties ---------- -+-------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`echo` | -+-------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-------------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`scancode` | -+-------------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`unicode` | -+-------------------------+--------------------------------------------------------+ ++-------------------------+--------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`echo` | false | ++-------------------------+--------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`pressed` | false | ++-------------------------+--------------------------------------------------------+-------+ +| :ref:`int` | :ref:`scancode` | 0 | ++-------------------------+--------------------------------------------------------+-------+ +| :ref:`int` | :ref:`unicode` | 0 | ++-------------------------+--------------------------------------------------------+-------+ Methods ------- @@ -53,11 +53,13 @@ Property Descriptions - :ref:`bool` **echo** -+----------+-----------------+ -| *Setter* | set_echo(value) | -+----------+-----------------+ -| *Getter* | is_echo() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_echo(value) | ++-----------+-----------------+ +| *Getter* | is_echo() | ++-----------+-----------------+ If ``true``, the key was already pressed before this event. It means the user is holding the key down. @@ -65,11 +67,13 @@ If ``true``, the key was already pressed before this event. It means the user is - :ref:`bool` **pressed** -+----------+--------------------+ -| *Setter* | set_pressed(value) | -+----------+--------------------+ -| *Getter* | is_pressed() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_pressed(value) | ++-----------+--------------------+ +| *Getter* | is_pressed() | ++-----------+--------------------+ If ``true``, the key's state is pressed. If ``false``, the key's state is released. @@ -77,11 +81,13 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas - :ref:`int` **scancode** -+----------+---------------------+ -| *Setter* | set_scancode(value) | -+----------+---------------------+ -| *Getter* | get_scancode() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_scancode(value) | ++-----------+---------------------+ +| *Getter* | get_scancode() | ++-----------+---------------------+ Key scancode, one of the :ref:`KeyList` constants. @@ -89,11 +95,13 @@ Key scancode, one of the :ref:`KeyList` constants. - :ref:`int` **unicode** -+----------+--------------------+ -| *Setter* | set_unicode(value) | -+----------+--------------------+ -| *Getter* | get_unicode() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_unicode(value) | ++-----------+--------------------+ +| *Getter* | get_unicode() | ++-----------+--------------------+ Key Unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See :ref:`OS.set_ime_active` for more information. diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index 66163f3ff..33f3e010e 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`factor` | -+---------------------------+---------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`factor` | 1.0 | ++---------------------------+---------------------------------------------------------------+-----+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`float` **factor** -+----------+-------------------+ -| *Setter* | set_factor(value) | -+----------+-------------------+ -| *Getter* | get_factor() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_factor(value) | ++-----------+-------------------+ +| *Getter* | get_factor() | ++-----------+-------------------+ diff --git a/classes/class_inputeventmidi.rst b/classes/class_inputeventmidi.rst index 7ce348faa..5ad9fc709 100644 --- a/classes/class_inputeventmidi.rst +++ b/classes/class_inputeventmidi.rst @@ -19,23 +19,23 @@ Brief Description Properties ---------- -+-----------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`channel` | -+-----------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`controller_number` | -+-----------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`controller_value` | -+-----------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`instrument` | -+-----------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`message` | -+-----------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`pitch` | -+-----------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`pressure` | -+-----------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`velocity` | -+-----------------------+---------------------------------------------------------------------------+ ++-----------------------+---------------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`channel` | 0 | ++-----------------------+---------------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`controller_number` | 0 | ++-----------------------+---------------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`controller_value` | 0 | ++-----------------------+---------------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`instrument` | 0 | ++-----------------------+---------------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`message` | 0 | ++-----------------------+---------------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`pitch` | 0 | ++-----------------------+---------------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`pressure` | 0 | ++-----------------------+---------------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`velocity` | 0 | ++-----------------------+---------------------------------------------------------------------------+---+ Property Descriptions --------------------- @@ -44,79 +44,95 @@ Property Descriptions - :ref:`int` **channel** -+----------+--------------------+ -| *Setter* | set_channel(value) | -+----------+--------------------+ -| *Getter* | get_channel() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_channel(value) | ++-----------+--------------------+ +| *Getter* | get_channel() | ++-----------+--------------------+ .. _class_InputEventMIDI_property_controller_number: - :ref:`int` **controller_number** -+----------+------------------------------+ -| *Setter* | set_controller_number(value) | -+----------+------------------------------+ -| *Getter* | get_controller_number() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | 0 | ++-----------+------------------------------+ +| *Setter* | set_controller_number(value) | ++-----------+------------------------------+ +| *Getter* | get_controller_number() | ++-----------+------------------------------+ .. _class_InputEventMIDI_property_controller_value: - :ref:`int` **controller_value** -+----------+-----------------------------+ -| *Setter* | set_controller_value(value) | -+----------+-----------------------------+ -| *Getter* | get_controller_value() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0 | ++-----------+-----------------------------+ +| *Setter* | set_controller_value(value) | ++-----------+-----------------------------+ +| *Getter* | get_controller_value() | ++-----------+-----------------------------+ .. _class_InputEventMIDI_property_instrument: - :ref:`int` **instrument** -+----------+-----------------------+ -| *Setter* | set_instrument(value) | -+----------+-----------------------+ -| *Getter* | get_instrument() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_instrument(value) | ++-----------+-----------------------+ +| *Getter* | get_instrument() | ++-----------+-----------------------+ .. _class_InputEventMIDI_property_message: - :ref:`int` **message** -+----------+--------------------+ -| *Setter* | set_message(value) | -+----------+--------------------+ -| *Getter* | get_message() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_message(value) | ++-----------+--------------------+ +| *Getter* | get_message() | ++-----------+--------------------+ .. _class_InputEventMIDI_property_pitch: - :ref:`int` **pitch** -+----------+------------------+ -| *Setter* | set_pitch(value) | -+----------+------------------+ -| *Getter* | get_pitch() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_pitch(value) | ++-----------+------------------+ +| *Getter* | get_pitch() | ++-----------+------------------+ .. _class_InputEventMIDI_property_pressure: - :ref:`int` **pressure** -+----------+---------------------+ -| *Setter* | set_pressure(value) | -+----------+---------------------+ -| *Getter* | get_pressure() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_pressure(value) | ++-----------+---------------------+ +| *Getter* | get_pressure() | ++-----------+---------------------+ .. _class_InputEventMIDI_property_velocity: - :ref:`int` **velocity** -+----------+---------------------+ -| *Setter* | set_velocity(value) | -+----------+---------------------+ -| *Getter* | get_velocity() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_velocity(value) | ++-----------+---------------------+ +| *Getter* | get_velocity() | ++-----------+---------------------+ diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 1da46bec0..116f27a08 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -21,13 +21,13 @@ Base input event type for mouse events. Properties ---------- -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`button_mask` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`global_position` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`button_mask` | 0 | ++-------------------------------+------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`global_position` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`position` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------------------------------+-----------------+ Description ----------- @@ -46,11 +46,13 @@ Property Descriptions - :ref:`int` **button_mask** -+----------+------------------------+ -| *Setter* | set_button_mask(value) | -+----------+------------------------+ -| *Getter* | get_button_mask() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_button_mask(value) | ++-----------+------------------------+ +| *Getter* | get_button_mask() | ++-----------+------------------------+ The mouse button mask identifier, one of or a bitwise combination of the :ref:`ButtonList` button masks. @@ -58,11 +60,13 @@ The mouse button mask identifier, one of or a bitwise combination of the :ref:`B - :ref:`Vector2` **global_position** -+----------+----------------------------+ -| *Setter* | set_global_position(value) | -+----------+----------------------------+ -| *Getter* | get_global_position() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+----------------------------+ +| *Setter* | set_global_position(value) | ++-----------+----------------------------+ +| *Getter* | get_global_position() | ++-----------+----------------------------+ The global mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. @@ -70,11 +74,13 @@ The global mouse position relative to the current :ref:`Viewport - :ref:`Vector2` **position** -+----------+---------------------+ -| *Setter* | set_position(value) | -+----------+---------------------+ -| *Getter* | get_position() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_position(value) | ++-----------+---------------------+ +| *Getter* | get_position() | ++-----------+---------------------+ The local mouse position relative to the :ref:`Viewport`. If used in :ref:`Control._gui_input`, the position is relative to the current :ref:`Control` which is under the mouse. diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 258fb9a79..e70083a00 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -19,15 +19,15 @@ Input event type for mouse button events. Properties ---------- -+---------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`button_index` | -+---------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`doubleclick` | -+---------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`factor` | -+---------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+---------------------------+------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`button_index` | 0 | ++---------------------------+------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`doubleclick` | false | ++---------------------------+------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`factor` | 1.0 | ++---------------------------+------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`pressed` | false | ++---------------------------+------------------------------------------------------------------------+-------+ Description ----------- @@ -46,11 +46,13 @@ Property Descriptions - :ref:`int` **button_index** -+----------+-------------------------+ -| *Setter* | set_button_index(value) | -+----------+-------------------------+ -| *Getter* | get_button_index() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_button_index(value) | ++-----------+-------------------------+ +| *Getter* | get_button_index() | ++-----------+-------------------------+ The mouse button identifier, one of the :ref:`ButtonList` button or button wheel constants. @@ -58,11 +60,13 @@ The mouse button identifier, one of the :ref:`ButtonList` **doubleclick** -+----------+------------------------+ -| *Setter* | set_doubleclick(value) | -+----------+------------------------+ -| *Getter* | is_doubleclick() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_doubleclick(value) | ++-----------+------------------------+ +| *Getter* | is_doubleclick() | ++-----------+------------------------+ If ``true``, the mouse button's state is a double-click. @@ -70,11 +74,13 @@ If ``true``, the mouse button's state is a double-click. - :ref:`float` **factor** -+----------+-------------------+ -| *Setter* | set_factor(value) | -+----------+-------------------+ -| *Getter* | get_factor() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_factor(value) | ++-----------+-------------------+ +| *Getter* | get_factor() | ++-----------+-------------------+ The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be ``0`` if not supported. @@ -82,11 +88,13 @@ The amount (or delta) of the event. When used for high-precision scroll events, - :ref:`bool` **pressed** -+----------+--------------------+ -| *Setter* | set_pressed(value) | -+----------+--------------------+ -| *Getter* | is_pressed() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_pressed(value) | ++-----------+--------------------+ +| *Getter* | is_pressed() | ++-----------+--------------------+ If ``true``, the mouse button's state is pressed. If ``false``, the mouse button's state is released. diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 3e88fc2a7..64c9ab591 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -19,11 +19,11 @@ Input event type for mouse motion events. Properties ---------- -+-------------------------------+----------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`relative` | -+-------------------------------+----------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`speed` | -+-------------------------------+----------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`relative` | Vector2( 0, 0 ) | ++-------------------------------+----------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`speed` | Vector2( 0, 0 ) | ++-------------------------------+----------------------------------------------------------------+-----------------+ Description ----------- @@ -42,11 +42,13 @@ Property Descriptions - :ref:`Vector2` **relative** -+----------+---------------------+ -| *Setter* | set_relative(value) | -+----------+---------------------+ -| *Getter* | get_relative() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_relative(value) | ++-----------+---------------------+ +| *Getter* | get_relative() | ++-----------+---------------------+ The mouse position relative to the previous position (position at the last frame). @@ -54,11 +56,13 @@ The mouse position relative to the previous position (position at the last frame - :ref:`Vector2` **speed** -+----------+------------------+ -| *Setter* | set_speed(value) | -+----------+------------------+ -| *Getter* | get_speed() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+------------------+ +| *Setter* | set_speed(value) | ++-----------+------------------+ +| *Getter* | get_speed() | ++-----------+------------------+ The mouse speed in pixels per second. diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 33088db9a..c185ddb2d 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------------+---------------------------------------------------------+ -| :ref:`Vector2` | :ref:`delta` | -+-------------------------------+---------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`delta` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------+-----------------+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`Vector2` **delta** -+----------+------------------+ -| *Setter* | set_delta(value) | -+----------+------------------+ -| *Getter* | get_delta() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+------------------+ +| *Setter* | set_delta(value) | ++-----------+------------------+ +| *Getter* | get_delta() | ++-----------+------------------+ diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index df54aaecb..81d7e59a9 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -19,15 +19,15 @@ Input event type for screen drag events. Only available on mobile devices. Properties ---------- -+-------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`index` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`relative` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`speed` | -+-------------------------------+---------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`index` | 0 | ++-------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`position` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`relative` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`speed` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------+-----------------+ Description ----------- @@ -46,11 +46,13 @@ Property Descriptions - :ref:`int` **index** -+----------+------------------+ -| *Setter* | set_index(value) | -+----------+------------------+ -| *Getter* | get_index() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_index(value) | ++-----------+------------------+ +| *Getter* | get_index() | ++-----------+------------------+ The drag event index in the case of a multi-drag event. @@ -58,11 +60,13 @@ The drag event index in the case of a multi-drag event. - :ref:`Vector2` **position** -+----------+---------------------+ -| *Setter* | set_position(value) | -+----------+---------------------+ -| *Getter* | get_position() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_position(value) | ++-----------+---------------------+ +| *Getter* | get_position() | ++-----------+---------------------+ The drag position. @@ -70,11 +74,13 @@ The drag position. - :ref:`Vector2` **relative** -+----------+---------------------+ -| *Setter* | set_relative(value) | -+----------+---------------------+ -| *Getter* | get_relative() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_relative(value) | ++-----------+---------------------+ +| *Getter* | get_relative() | ++-----------+---------------------+ The drag position relative to its start position. @@ -82,11 +88,13 @@ The drag position relative to its start position. - :ref:`Vector2` **speed** -+----------+------------------+ -| *Setter* | set_speed(value) | -+----------+------------------+ -| *Getter* | get_speed() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+------------------+ +| *Setter* | set_speed(value) | ++-----------+------------------+ +| *Getter* | get_speed() | ++-----------+------------------+ The drag speed. diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 23abeb4fe..eae253efb 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -21,13 +21,13 @@ Input event type for screen touch events. Properties ---------- -+-------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`index` | -+-------------------------------+----------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-------------------------------+----------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`index` | 0 | ++-------------------------------+----------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`position` | Vector2( 0, 0 ) | ++-------------------------------+----------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`pressed` | false | ++-------------------------------+----------------------------------------------------------------+-----------------+ Description ----------- @@ -46,11 +46,13 @@ Property Descriptions - :ref:`int` **index** -+----------+------------------+ -| *Setter* | set_index(value) | -+----------+------------------+ -| *Getter* | get_index() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_index(value) | ++-----------+------------------+ +| *Getter* | get_index() | ++-----------+------------------+ The touch index in the case of a multi-touch event. One index = one finger. @@ -58,11 +60,13 @@ The touch index in the case of a multi-touch event. One index = one finger. - :ref:`Vector2` **position** -+----------+---------------------+ -| *Setter* | set_position(value) | -+----------+---------------------+ -| *Getter* | get_position() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_position(value) | ++-----------+---------------------+ +| *Getter* | get_position() | ++-----------+---------------------+ The touch position. @@ -70,11 +74,13 @@ The touch position. - :ref:`bool` **pressed** -+----------+--------------------+ -| *Setter* | set_pressed(value) | -+----------+--------------------+ -| *Getter* | is_pressed() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_pressed(value) | ++-----------+--------------------+ +| *Getter* | is_pressed() | ++-----------+--------------------+ If ``true``, the touch's state is pressed. If ``false``, the touch's state is released. diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index de5fae86b..f19552503 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -21,17 +21,17 @@ Base class for keys events with modifiers. Properties ---------- -+-------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`alt` | -+-------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`command` | -+-------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`control` | -+-------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`meta` | -+-------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`shift` | -+-------------------------+----------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`alt` | false | ++-------------------------+----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`command` | false | ++-------------------------+----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`control` | false | ++-------------------------+----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`meta` | false | ++-------------------------+----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`shift` | false | ++-------------------------+----------------------------------------------------------------+-------+ Description ----------- @@ -50,11 +50,13 @@ Property Descriptions - :ref:`bool` **alt** -+----------+----------------+ -| *Setter* | set_alt(value) | -+----------+----------------+ -| *Getter* | get_alt() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | false | ++-----------+----------------+ +| *Setter* | set_alt(value) | ++-----------+----------------+ +| *Getter* | get_alt() | ++-----------+----------------+ State of the ``Alt`` modifier. @@ -62,11 +64,13 @@ State of the ``Alt`` modifier. - :ref:`bool` **command** -+----------+--------------------+ -| *Setter* | set_command(value) | -+----------+--------------------+ -| *Getter* | get_command() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_command(value) | ++-----------+--------------------+ +| *Getter* | get_command() | ++-----------+--------------------+ State of the ``Command`` modifier. @@ -74,11 +78,13 @@ State of the ``Command`` modifier. - :ref:`bool` **control** -+----------+--------------------+ -| *Setter* | set_control(value) | -+----------+--------------------+ -| *Getter* | get_control() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_control(value) | ++-----------+--------------------+ +| *Getter* | get_control() | ++-----------+--------------------+ State of the ``Ctrl`` modifier. @@ -86,11 +92,13 @@ State of the ``Ctrl`` modifier. - :ref:`bool` **meta** -+----------+--------------------+ -| *Setter* | set_metakey(value) | -+----------+--------------------+ -| *Getter* | get_metakey() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_metakey(value) | ++-----------+--------------------+ +| *Getter* | get_metakey() | ++-----------+--------------------+ State of the ``Meta`` modifier. @@ -98,11 +106,13 @@ State of the ``Meta`` modifier. - :ref:`bool` **shift** -+----------+------------------+ -| *Setter* | set_shift(value) | -+----------+------------------+ -| *Getter* | get_shift() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | false | ++-----------+------------------+ +| *Setter* | set_shift(value) | ++-----------+------------------+ +| *Getter* | get_shift() | ++-----------+------------------+ State of the ``Shift`` modifier. diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index 272a1c349..d4a5a2056 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -19,13 +19,13 @@ Camera which moves toward another node. Properties ---------- -+---------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`speed` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`NodePath` | :ref:`target` | -+---------------------------------+-----------------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`enabled` | false | ++---------------------------------+-----------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`speed` | 1.0 | ++---------------------------------+-----------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`target` | NodePath("") | ++---------------------------------+-----------------------------------------------------------+--------------+ Methods ------- @@ -48,11 +48,13 @@ Property Descriptions - :ref:`bool` **enabled** -+----------+----------------------------------+ -| *Setter* | set_interpolation_enabled(value) | -+----------+----------------------------------+ -| *Getter* | is_interpolation_enabled() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_interpolation_enabled(value) | ++-----------+----------------------------------+ +| *Getter* | is_interpolation_enabled() | ++-----------+----------------------------------+ If ``true``, and a target is set, the camera will move automatically. @@ -60,11 +62,13 @@ If ``true``, and a target is set, the camera will move automatically. - :ref:`float` **speed** -+----------+------------------+ -| *Setter* | set_speed(value) | -+----------+------------------+ -| *Getter* | get_speed() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_speed(value) | ++-----------+------------------+ +| *Getter* | get_speed() | ++-----------+------------------+ How quickly the camera moves toward its target. Higher values will result in tighter camera motion. @@ -72,11 +76,13 @@ How quickly the camera moves toward its target. Higher values will result in tig - :ref:`NodePath` **target** -+----------+------------------------+ -| *Setter* | set_target_path(value) | -+----------+------------------------+ -| *Getter* | get_target_path() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | NodePath("") | ++-----------+------------------------+ +| *Setter* | set_target_path(value) | ++-----------+------------------------+ +| *Getter* | get_target_path() | ++-----------+------------------------+ The target's :ref:`NodePath`. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 8b7e1d8ad..5abf1043a 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -19,29 +19,29 @@ Control that provides a list of selectable items (and/or icons) in a single colu Properties ---------- -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_reselect` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_rmb_select` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_height` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_column_width` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`fixed_icon_size` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`IconMode` | :ref:`icon_mode` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`icon_scale` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_columns` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_text_lines` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`same_column_width` | -+---------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`SelectMode` | :ref:`select_mode` | -+---------------------------------------------+-----------------------------------------------------------------------+ ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`allow_reselect` | false | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`allow_rmb_select` | false | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`auto_height` | false | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`fixed_column_width` | 0 | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`fixed_icon_size` | Vector2( 0, 0 ) | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`IconMode` | :ref:`icon_mode` | 1 | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`icon_scale` | 1.0 | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`max_columns` | 1 | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`max_text_lines` | 1 | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`same_column_width` | false | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ +| :ref:`SelectMode` | :ref:`select_mode` | 0 | ++---------------------------------------------+-----------------------------------------------------------------------+-----------------+ Methods ------- @@ -131,35 +131,35 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`StyleBox` | bg | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | bg_focus | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | cursor | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | cursor_unfocused | -+---------------------------------+---------------------+ -| :ref:`Font` | font | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_selected | -+---------------------------------+---------------------+ -| :ref:`Color` | guide_color | -+---------------------------------+---------------------+ -| :ref:`int` | hseparation | -+---------------------------------+---------------------+ -| :ref:`int` | icon_margin | -+---------------------------------+---------------------+ -| :ref:`int` | line_separation | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | selected | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | selected_focus | -+---------------------------------+---------------------+ -| :ref:`int` | vseparation | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | bg | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | bg_focus | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | cursor | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | cursor_unfocused | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.627451, 0.627451, 0.627451, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_selected | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | guide_color | Color( 0, 0, 0, 0.1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | hseparation | 4 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | icon_margin | 4 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | line_separation | 2 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | selected | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | selected_focus | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | vseparation | 2 | ++---------------------------------+---------------------+------------------------------------------+ Signals ------- @@ -249,11 +249,13 @@ Property Descriptions - :ref:`bool` **allow_reselect** -+----------+---------------------------+ -| *Setter* | set_allow_reselect(value) | -+----------+---------------------------+ -| *Getter* | get_allow_reselect() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_allow_reselect(value) | ++-----------+---------------------------+ +| *Getter* | get_allow_reselect() | ++-----------+---------------------------+ If ``true``, the currently selected item can be selected again. @@ -261,11 +263,13 @@ If ``true``, the currently selected item can be selected again. - :ref:`bool` **allow_rmb_select** -+----------+-----------------------------+ -| *Setter* | set_allow_rmb_select(value) | -+----------+-----------------------------+ -| *Getter* | get_allow_rmb_select() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | false | ++-----------+-----------------------------+ +| *Setter* | set_allow_rmb_select(value) | ++-----------+-----------------------------+ +| *Getter* | get_allow_rmb_select() | ++-----------+-----------------------------+ If ``true``, right mouse button click can select items. @@ -273,11 +277,13 @@ If ``true``, right mouse button click can select items. - :ref:`bool` **auto_height** -+----------+------------------------+ -| *Setter* | set_auto_height(value) | -+----------+------------------------+ -| *Getter* | has_auto_height() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_auto_height(value) | ++-----------+------------------------+ +| *Getter* | has_auto_height() | ++-----------+------------------------+ If ``true``, the control will automatically resize the height to fit its content. @@ -285,11 +291,13 @@ If ``true``, the control will automatically resize the height to fit its content - :ref:`int` **fixed_column_width** -+----------+-------------------------------+ -| *Setter* | set_fixed_column_width(value) | -+----------+-------------------------------+ -| *Getter* | get_fixed_column_width() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0 | ++-----------+-------------------------------+ +| *Setter* | set_fixed_column_width(value) | ++-----------+-------------------------------+ +| *Getter* | get_fixed_column_width() | ++-----------+-------------------------------+ Sets the default column width in pixels. If left to default value, each item will have a width equal to the width of its content and the columns will have an uneven width. @@ -297,11 +305,13 @@ Sets the default column width in pixels. If left to default value, each item wil - :ref:`Vector2` **fixed_icon_size** -+----------+----------------------------+ -| *Setter* | set_fixed_icon_size(value) | -+----------+----------------------------+ -| *Getter* | get_fixed_icon_size() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+----------------------------+ +| *Setter* | set_fixed_icon_size(value) | ++-----------+----------------------------+ +| *Getter* | get_fixed_icon_size() | ++-----------+----------------------------+ Sets the default icon size in pixels. @@ -309,11 +319,13 @@ Sets the default icon size in pixels. - :ref:`IconMode` **icon_mode** -+----------+----------------------+ -| *Setter* | set_icon_mode(value) | -+----------+----------------------+ -| *Getter* | get_icon_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1 | ++-----------+----------------------+ +| *Setter* | set_icon_mode(value) | ++-----------+----------------------+ +| *Getter* | get_icon_mode() | ++-----------+----------------------+ Sets the default position of the icon to either :ref:`ICON_MODE_LEFT` or :ref:`ICON_MODE_TOP`. @@ -321,23 +333,27 @@ Sets the default position of the icon to either :ref:`ICON_MODE_LEFT` **icon_scale** -+----------+-----------------------+ -| *Setter* | set_icon_scale(value) | -+----------+-----------------------+ -| *Getter* | get_icon_scale() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_icon_scale(value) | ++-----------+-----------------------+ +| *Getter* | get_icon_scale() | ++-----------+-----------------------+ -Sets the icon size to its initial size multiplied by the specified scale. Default value is 1.0. +Sets the icon size to its initial size multiplied by the specified scale. .. _class_ItemList_property_max_columns: - :ref:`int` **max_columns** -+----------+------------------------+ -| *Setter* | set_max_columns(value) | -+----------+------------------------+ -| *Getter* | get_max_columns() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1 | ++-----------+------------------------+ +| *Setter* | set_max_columns(value) | ++-----------+------------------------+ +| *Getter* | get_max_columns() | ++-----------+------------------------+ Sets the maximum columns the list will have. If set to anything other than the default, the content will be split among the specified columns. @@ -345,21 +361,25 @@ Sets the maximum columns the list will have. If set to anything other than the d - :ref:`int` **max_text_lines** -+----------+---------------------------+ -| *Setter* | set_max_text_lines(value) | -+----------+---------------------------+ -| *Getter* | get_max_text_lines() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_max_text_lines(value) | ++-----------+---------------------------+ +| *Getter* | get_max_text_lines() | ++-----------+---------------------------+ .. _class_ItemList_property_same_column_width: - :ref:`bool` **same_column_width** -+----------+------------------------------+ -| *Setter* | set_same_column_width(value) | -+----------+------------------------------+ -| *Getter* | is_same_column_width() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_same_column_width(value) | ++-----------+------------------------------+ +| *Getter* | is_same_column_width() | ++-----------+------------------------------+ If set to ``true``, all columns will have the same width specified by :ref:`fixed_column_width`. @@ -367,11 +387,13 @@ If set to ``true``, all columns will have the same width specified by :ref:`fixe - :ref:`SelectMode` **select_mode** -+----------+------------------------+ -| *Setter* | set_select_mode(value) | -+----------+------------------------+ -| *Getter* | get_select_mode() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_select_mode(value) | ++-----------+------------------------+ +| *Getter* | get_select_mode() | ++-----------+------------------------+ Allows single or multiple item selection. See the :ref:`SelectMode` constants. @@ -420,19 +442,19 @@ Returns the number of items currently in the list. - :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const -Returns the custom background color of the item specified by ``idx`` index. Default value is ``Color(0, 0, 0, 0)``. +Returns the custom background color of the item specified by ``idx`` index. .. _class_ItemList_method_get_item_custom_fg_color: - :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const -Returns the custom foreground color of the item specified by ``idx`` index. Default value is ``Color(0, 0, 0, 0)``. +Returns the custom foreground color of the item specified by ``idx`` index. .. _class_ItemList_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const -Returns the icon associated with the specified index. Default value is ``null``. +Returns the icon associated with the specified index. .. _class_ItemList_method_get_item_icon_modulate: diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 5696d2bb5..6d80755c6 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -21,15 +21,15 @@ Base class for all 3D joints. Properties ---------- -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collision/exclude_nodes` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`nodes/node_a` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`nodes/node_b` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`solver/priority` | -+---------------------------------+------------------------------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`collision/exclude_nodes` | true | ++---------------------------------+------------------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`nodes/node_a` | NodePath("") | ++---------------------------------+------------------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`nodes/node_b` | NodePath("") | ++---------------------------------+------------------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`solver/priority` | 1 | ++---------------------------------+------------------------------------------------------------------------------+--------------+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`bool` **collision/exclude_nodes** -+----------+-----------------------------------------+ -| *Setter* | set_exclude_nodes_from_collision(value) | -+----------+-----------------------------------------+ -| *Getter* | get_exclude_nodes_from_collision() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | true | ++-----------+-----------------------------------------+ +| *Setter* | set_exclude_nodes_from_collision(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_exclude_nodes_from_collision() | ++-----------+-----------------------------------------+ If ``true``, the two bodies of the nodes are not able to collide with each other. @@ -55,11 +57,13 @@ If ``true``, the two bodies of the nodes are not able to collide with each other - :ref:`NodePath` **nodes/node_a** -+----------+-------------------+ -| *Setter* | set_node_a(value) | -+----------+-------------------+ -| *Getter* | get_node_a() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | NodePath("") | ++-----------+-------------------+ +| *Setter* | set_node_a(value) | ++-----------+-------------------+ +| *Getter* | get_node_a() | ++-----------+-------------------+ The node attached to the first side (A) of the joint. @@ -67,11 +71,13 @@ The node attached to the first side (A) of the joint. - :ref:`NodePath` **nodes/node_b** -+----------+-------------------+ -| *Setter* | set_node_b(value) | -+----------+-------------------+ -| *Getter* | get_node_b() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | NodePath("") | ++-----------+-------------------+ +| *Setter* | set_node_b(value) | ++-----------+-------------------+ +| *Getter* | get_node_b() | ++-----------+-------------------+ The node attached to the second side (B) of the joint. @@ -79,11 +85,13 @@ The node attached to the second side (B) of the joint. - :ref:`int` **solver/priority** -+----------+----------------------------+ -| *Setter* | set_solver_priority(value) | -+----------+----------------------------+ -| *Getter* | get_solver_priority() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1 | ++-----------+----------------------------+ +| *Setter* | set_solver_priority(value) | ++-----------+----------------------------+ +| *Getter* | get_solver_priority() | ++-----------+----------------------------+ The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority. diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 2a0337b3d..7c21b23d8 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -21,15 +21,15 @@ Base node for all joint constraints in 2D physics. Properties ---------- -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`bias` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disable_collision` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_a` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_b` | -+---------------------------------+--------------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`bias` | 0.0 | ++---------------------------------+--------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`disable_collision` | true | ++---------------------------------+--------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`node_a` | NodePath("") | ++---------------------------------+--------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`node_b` | NodePath("") | ++---------------------------------+--------------------------------------------------------------------+--------------+ Description ----------- @@ -43,35 +43,41 @@ Property Descriptions - :ref:`float` **bias** -+----------+-----------------+ -| *Setter* | set_bias(value) | -+----------+-----------------+ -| *Getter* | get_bias() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0.0 | ++-----------+-----------------+ +| *Setter* | set_bias(value) | ++-----------+-----------------+ +| *Getter* | get_bias() | ++-----------+-----------------+ -When :ref:`node_a` and :ref:`node_b` move in different directions the ``bias`` controls how fast the joint pulls them back to their original position. The lower the ``bias`` the more the two bodies can pull on the joint. Default value: ``0``. +When :ref:`node_a` and :ref:`node_b` move in different directions the ``bias`` controls how fast the joint pulls them back to their original position. The lower the ``bias`` the more the two bodies can pull on the joint. .. _class_Joint2D_property_disable_collision: - :ref:`bool` **disable_collision** -+----------+-----------------------------------------+ -| *Setter* | set_exclude_nodes_from_collision(value) | -+----------+-----------------------------------------+ -| *Getter* | get_exclude_nodes_from_collision() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | true | ++-----------+-----------------------------------------+ +| *Setter* | set_exclude_nodes_from_collision(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_exclude_nodes_from_collision() | ++-----------+-----------------------------------------+ -If ``true``, :ref:`node_a` and :ref:`node_b` can collide. Default value: ``false``. +If ``true``, :ref:`node_a` and :ref:`node_b` can collide. .. _class_Joint2D_property_node_a: - :ref:`NodePath` **node_a** -+----------+-------------------+ -| *Setter* | set_node_a(value) | -+----------+-------------------+ -| *Getter* | get_node_a() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | NodePath("") | ++-----------+-------------------+ +| *Setter* | set_node_a(value) | ++-----------+-------------------+ +| *Getter* | get_node_a() | ++-----------+-------------------+ The first body attached to the joint. Must derive from :ref:`PhysicsBody2D`. @@ -79,11 +85,13 @@ The first body attached to the joint. Must derive from :ref:`PhysicsBody2D` **node_b** -+----------+-------------------+ -| *Setter* | set_node_b(value) | -+----------+-------------------+ -| *Getter* | get_node_b() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | NodePath("") | ++-----------+-------------------+ +| *Setter* | set_node_b(value) | ++-----------+-------------------+ +| *Getter* | get_node_b() | ++-----------+-------------------+ The second body attached to the joint. Must derive from :ref:`PhysicsBody2D`. diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index f362c29bb..516868cf1 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -19,15 +19,15 @@ Data class wrapper for decoded JSON. Properties ---------- -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`Error` | :ref:`error` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`error_line` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`String` | :ref:`error_string` | -+---------------------------------------+------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`result` | -+---------------------------------------+------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------+----+ +| :ref:`Error` | :ref:`error` | | ++---------------------------------------+------------------------------------------------------------------+----+ +| :ref:`int` | :ref:`error_line` | -1 | ++---------------------------------------+------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`error_string` | "" | ++---------------------------------------+------------------------------------------------------------------+----+ +| :ref:`Variant` | :ref:`result` | | ++---------------------------------------+------------------------------------------------------------------+----+ Description ----------- @@ -53,11 +53,13 @@ The error type if the JSON source was not successfully parsed. See the :ref:`@Gl - :ref:`int` **error_line** -+----------+-----------------------+ -| *Setter* | set_error_line(value) | -+----------+-----------------------+ -| *Getter* | get_error_line() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | -1 | ++-----------+-----------------------+ +| *Setter* | set_error_line(value) | ++-----------+-----------------------+ +| *Getter* | get_error_line() | ++-----------+-----------------------+ The line number where the error occurred if JSON source was not successfully parsed. @@ -65,11 +67,13 @@ The line number where the error occurred if JSON source was not successfully par - :ref:`String` **error_string** -+----------+-------------------------+ -| *Setter* | set_error_string(value) | -+----------+-------------------------+ -| *Getter* | get_error_string() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | "" | ++-----------+-------------------------+ +| *Setter* | set_error_string(value) | ++-----------+-------------------------+ +| *Getter* | get_error_string() | ++-----------+-------------------------+ The error message if JSON source was not successfully parsed. See the :ref:`@GlobalScope` ``ERR_*`` constants. diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 3247f7288..56fd41f0b 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -19,15 +19,15 @@ Kinematic body 3D node. Properties ---------- -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`collision/safe_margin` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`move_lock_x` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`move_lock_y` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`move_lock_z` | -+---------------------------+----------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`collision/safe_margin` | 0.001 | ++---------------------------+----------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`move_lock_x` | false | ++---------------------------+----------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`move_lock_y` | false | ++---------------------------+----------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`move_lock_z` | false | ++---------------------------+----------------------------------------------------------------------------------+-------+ Methods ------- @@ -75,11 +75,13 @@ Property Descriptions - :ref:`float` **collision/safe_margin** -+----------+------------------------+ -| *Setter* | set_safe_margin(value) | -+----------+------------------------+ -| *Getter* | get_safe_margin() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.001 | ++-----------+------------------------+ +| *Setter* | set_safe_margin(value) | ++-----------+------------------------+ +| *Getter* | get_safe_margin() | ++-----------+------------------------+ If the body is at least this close to another body, this body will consider them to be colliding. @@ -87,11 +89,13 @@ If the body is at least this close to another body, this body will consider them - :ref:`bool` **move_lock_x** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's X axis movement. @@ -99,11 +103,13 @@ Lock the body's X axis movement. - :ref:`bool` **move_lock_y** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's Y axis movement. @@ -111,11 +117,13 @@ Lock the body's Y axis movement. - :ref:`bool` **move_lock_z** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's Z axis movement. diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index b4c99550d..4cc2d2d72 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -19,11 +19,11 @@ Kinematic body 2D node. Properties ---------- -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`collision/safe_margin` | -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`motion/sync_to_physics` | -+---------------------------+--------------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`collision/safe_margin` | 0.08 | ++---------------------------+--------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`motion/sync_to_physics` | false | ++---------------------------+--------------------------------------------------------------------------------------+-------+ Methods ------- @@ -73,11 +73,13 @@ Property Descriptions - :ref:`float` **collision/safe_margin** -+----------+------------------------+ -| *Setter* | set_safe_margin(value) | -+----------+------------------------+ -| *Getter* | get_safe_margin() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.08 | ++-----------+------------------------+ +| *Setter* | set_safe_margin(value) | ++-----------+------------------------+ +| *Getter* | get_safe_margin() | ++-----------+------------------------+ If the body is at least this close to another body, this body will consider them to be colliding. @@ -85,11 +87,13 @@ If the body is at least this close to another body, this body will consider them - :ref:`bool` **motion/sync_to_physics** -+----------+------------------------------+ -| *Setter* | set_sync_to_physics(value) | -+----------+------------------------------+ -| *Getter* | is_sync_to_physics_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_sync_to_physics(value) | ++-----------+------------------------------+ +| *Getter* | is_sync_to_physics_enabled() | ++-----------+------------------------------+ If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. Do **not** use together with :ref:`move_and_slide` or :ref:`move_and_collide` functions. diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index b810a8905..5cb37fb2b 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -19,29 +19,29 @@ Collision data for :ref:`KinematicBody` collisions. Properties ---------- -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_id` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collider_metadata` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider_shape` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_shape_index` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`collider_velocity` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`local_shape` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`normal` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`position` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`remainder` | -+-------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`travel` | -+-------------------------------+-------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Object` | :ref:`collider` | null | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`collider_id` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Variant` | :ref:`collider_metadata` | | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Object` | :ref:`collider_shape` | null | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`collider_shape_index` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`collider_velocity` | Vector3( 0, 0, 0 ) | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Object` | :ref:`local_shape` | null | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`normal` | Vector3( 0, 0, 0 ) | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`position` | Vector3( 0, 0, 0 ) | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`remainder` | Vector3( 0, 0, 0 ) | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`travel` | Vector3( 0, 0, 0 ) | ++-------------------------------+-------------------------------------------------------------------------------------+--------------------+ Description ----------- @@ -57,9 +57,11 @@ Property Descriptions - :ref:`Object` **collider** -+----------+----------------+ -| *Getter* | get_collider() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | null | ++-----------+----------------+ +| *Getter* | get_collider() | ++-----------+----------------+ The colliding body. @@ -67,9 +69,11 @@ The colliding body. - :ref:`int` **collider_id** -+----------+-------------------+ -| *Getter* | get_collider_id() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0 | ++-----------+-------------------+ +| *Getter* | get_collider_id() | ++-----------+-------------------+ The colliding body's unique :ref:`RID`. @@ -87,9 +91,11 @@ The colliding body's metadata. See :ref:`Object`. - :ref:`Object` **collider_shape** -+----------+----------------------+ -| *Getter* | get_collider_shape() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | null | ++-----------+----------------------+ +| *Getter* | get_collider_shape() | ++-----------+----------------------+ The colliding body's shape. @@ -97,9 +103,11 @@ The colliding body's shape. - :ref:`int` **collider_shape_index** -+----------+----------------------------+ -| *Getter* | get_collider_shape_index() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Getter* | get_collider_shape_index() | ++-----------+----------------------------+ The colliding shape's index. See :ref:`CollisionObject`. @@ -107,9 +115,11 @@ The colliding shape's index. See :ref:`CollisionObject`. - :ref:`Vector3` **collider_velocity** -+----------+-------------------------+ -| *Getter* | get_collider_velocity() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+-------------------------+ +| *Getter* | get_collider_velocity() | ++-----------+-------------------------+ The colliding object's velocity. @@ -117,9 +127,11 @@ The colliding object's velocity. - :ref:`Object` **local_shape** -+----------+-------------------+ -| *Getter* | get_local_shape() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | null | ++-----------+-------------------+ +| *Getter* | get_local_shape() | ++-----------+-------------------+ The moving object's colliding shape. @@ -127,9 +139,11 @@ The moving object's colliding shape. - :ref:`Vector3` **normal** -+----------+--------------+ -| *Getter* | get_normal() | -+----------+--------------+ ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ +| *Getter* | get_normal() | ++-----------+--------------------+ The colliding body's shape's normal at the point of collision. @@ -137,9 +151,11 @@ The colliding body's shape's normal at the point of collision. - :ref:`Vector3` **position** -+----------+----------------+ -| *Getter* | get_position() | -+----------+----------------+ ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ +| *Getter* | get_position() | ++-----------+--------------------+ The point of collision. @@ -147,9 +163,11 @@ The point of collision. - :ref:`Vector3` **remainder** -+----------+-----------------+ -| *Getter* | get_remainder() | -+----------+-----------------+ ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ +| *Getter* | get_remainder() | ++-----------+--------------------+ The moving object's remaining movement vector. @@ -157,9 +175,11 @@ The moving object's remaining movement vector. - :ref:`Vector3` **travel** -+----------+--------------+ -| *Getter* | get_travel() | -+----------+--------------+ ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ +| *Getter* | get_travel() | ++-----------+--------------------+ The distance the moving object traveled before collision. diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index fa5ae57ef..ecb69fadb 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -19,29 +19,29 @@ Collision data for :ref:`KinematicBody2D` collisions. Properties ---------- -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_id` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collider_metadata` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider_shape` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_shape_index` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`collider_velocity` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`local_shape` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`normal` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`remainder` | -+-------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`travel` | -+-------------------------------+---------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Object` | :ref:`collider` | null | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`collider_id` | 0 | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Variant` | :ref:`collider_metadata` | | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Object` | :ref:`collider_shape` | null | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`collider_shape_index` | 0 | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`collider_velocity` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Object` | :ref:`local_shape` | null | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`normal` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`position` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`remainder` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`travel` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------------------------------+-----------------+ Description ----------- @@ -57,9 +57,11 @@ Property Descriptions - :ref:`Object` **collider** -+----------+----------------+ -| *Getter* | get_collider() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | null | ++-----------+----------------+ +| *Getter* | get_collider() | ++-----------+----------------+ The colliding body. @@ -67,9 +69,11 @@ The colliding body. - :ref:`int` **collider_id** -+----------+-------------------+ -| *Getter* | get_collider_id() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0 | ++-----------+-------------------+ +| *Getter* | get_collider_id() | ++-----------+-------------------+ The colliding body's unique :ref:`RID`. @@ -87,9 +91,11 @@ The colliding body's metadata. See :ref:`Object`. - :ref:`Object` **collider_shape** -+----------+----------------------+ -| *Getter* | get_collider_shape() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | null | ++-----------+----------------------+ +| *Getter* | get_collider_shape() | ++-----------+----------------------+ The colliding body's shape. @@ -97,9 +103,11 @@ The colliding body's shape. - :ref:`int` **collider_shape_index** -+----------+----------------------------+ -| *Getter* | get_collider_shape_index() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Getter* | get_collider_shape_index() | ++-----------+----------------------------+ The colliding shape's index. See :ref:`CollisionObject2D`. @@ -107,9 +115,11 @@ The colliding shape's index. See :ref:`CollisionObject2D` **collider_velocity** -+----------+-------------------------+ -| *Getter* | get_collider_velocity() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------------+ +| *Getter* | get_collider_velocity() | ++-----------+-------------------------+ The colliding object's velocity. @@ -117,9 +127,11 @@ The colliding object's velocity. - :ref:`Object` **local_shape** -+----------+-------------------+ -| *Getter* | get_local_shape() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | null | ++-----------+-------------------+ +| *Getter* | get_local_shape() | ++-----------+-------------------+ The moving object's colliding shape. @@ -127,9 +139,11 @@ The moving object's colliding shape. - :ref:`Vector2` **normal** -+----------+--------------+ -| *Getter* | get_normal() | -+----------+--------------+ ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ +| *Getter* | get_normal() | ++-----------+-----------------+ The colliding body's shape's normal at the point of collision. @@ -137,9 +151,11 @@ The colliding body's shape's normal at the point of collision. - :ref:`Vector2` **position** -+----------+----------------+ -| *Getter* | get_position() | -+----------+----------------+ ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ +| *Getter* | get_position() | ++-----------+-----------------+ The point of collision. @@ -147,9 +163,11 @@ The point of collision. - :ref:`Vector2` **remainder** -+----------+-----------------+ -| *Getter* | get_remainder() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ +| *Getter* | get_remainder() | ++-----------+-----------------+ The moving object's remaining movement vector. @@ -157,9 +175,11 @@ The moving object's remaining movement vector. - :ref:`Vector2` **travel** -+----------+--------------+ -| *Getter* | get_travel() | -+----------+--------------+ ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ +| *Getter* | get_travel() | ++-----------+-----------------+ The distance the moving object traveled before collision. diff --git a/classes/class_label.rst b/classes/class_label.rst index 066f7d3ed..92edbf537 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -19,27 +19,27 @@ Displays plain text in a line or wrapped inside a rectangle. For formatted text, Properties ---------- -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`Align` | :ref:`align` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`autowrap` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`clip_text` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`lines_skipped` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_lines_visible` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`percent_visible` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`uppercase` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`VAlign` | :ref:`valign` | -+----------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`visible_characters` | -+----------------------------------+--------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`Align` | :ref:`align` | 0 | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`autowrap` | false | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`clip_text` | false | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`lines_skipped` | 0 | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`max_lines_visible` | -1 | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`percent_visible` | 1.0 | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`text` | "" | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`uppercase` | false | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`VAlign` | :ref:`valign` | 0 | ++----------------------------------+--------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`visible_characters` | -1 | ++----------------------------------+--------------------------------------------------------------------+-------+ Methods ------- @@ -57,25 +57,25 @@ Methods Theme Properties ---------------- -+---------------------------------+-----------------------+ -| :ref:`Font` | font | -+---------------------------------+-----------------------+ -| :ref:`Color` | font_color | -+---------------------------------+-----------------------+ -| :ref:`Color` | font_color_shadow | -+---------------------------------+-----------------------+ -| :ref:`Color` | font_outline_modulate | -+---------------------------------+-----------------------+ -| :ref:`int` | line_spacing | -+---------------------------------+-----------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+-----------------------+ -| :ref:`int` | shadow_as_outline | -+---------------------------------+-----------------------+ -| :ref:`int` | shadow_offset_x | -+---------------------------------+-----------------------+ -| :ref:`int` | shadow_offset_y | -+---------------------------------+-----------------------+ ++---------------------------------+-----------------------+---------------------+ +| :ref:`Font` | font | | ++---------------------------------+-----------------------+---------------------+ +| :ref:`Color` | font_color | Color( 1, 1, 1, 1 ) | ++---------------------------------+-----------------------+---------------------+ +| :ref:`Color` | font_color_shadow | Color( 0, 0, 0, 0 ) | ++---------------------------------+-----------------------+---------------------+ +| :ref:`Color` | font_outline_modulate | Color( 1, 1, 1, 1 ) | ++---------------------------------+-----------------------+---------------------+ +| :ref:`int` | line_spacing | 3 | ++---------------------------------+-----------------------+---------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+-----------------------+---------------------+ +| :ref:`int` | shadow_as_outline | 0 | ++---------------------------------+-----------------------+---------------------+ +| :ref:`int` | shadow_offset_x | 1 | ++---------------------------------+-----------------------+---------------------+ +| :ref:`int` | shadow_offset_y | 1 | ++---------------------------------+-----------------------+---------------------+ Enumerations ------------ @@ -134,11 +134,13 @@ Property Descriptions - :ref:`Align` **align** -+----------+------------------+ -| *Setter* | set_align(value) | -+----------+------------------+ -| *Getter* | get_align() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_align(value) | ++-----------+------------------+ +| *Getter* | get_align() | ++-----------+------------------+ Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants. @@ -146,23 +148,27 @@ Controls the text's horizontal align. Supports left, center, right, and fill, or - :ref:`bool` **autowrap** -+----------+---------------------+ -| *Setter* | set_autowrap(value) | -+----------+---------------------+ -| *Getter* | has_autowrap() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_autowrap(value) | ++-----------+---------------------+ +| *Getter* | has_autowrap() | ++-----------+---------------------+ -If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: ``false``. +If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. .. _class_Label_property_clip_text: - :ref:`bool` **clip_text** -+----------+----------------------+ -| *Setter* | set_clip_text(value) | -+----------+----------------------+ -| *Getter* | is_clipping_text() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_clip_text(value) | ++-----------+----------------------+ +| *Getter* | is_clipping_text() | ++-----------+----------------------+ If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. @@ -170,11 +176,13 @@ If ``true``, the Label only shows the text that fits inside its bounding rectang - :ref:`int` **lines_skipped** -+----------+--------------------------+ -| *Setter* | set_lines_skipped(value) | -+----------+--------------------------+ -| *Getter* | get_lines_skipped() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_lines_skipped(value) | ++-----------+--------------------------+ +| *Getter* | get_lines_skipped() | ++-----------+--------------------------+ The node ignores the first ``lines_skipped`` lines before it starts to display text. @@ -182,11 +190,13 @@ The node ignores the first ``lines_skipped`` lines before it starts to display t - :ref:`int` **max_lines_visible** -+----------+------------------------------+ -| *Setter* | set_max_lines_visible(value) | -+----------+------------------------------+ -| *Getter* | get_max_lines_visible() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | -1 | ++-----------+------------------------------+ +| *Setter* | set_max_lines_visible(value) | ++-----------+------------------------------+ +| *Getter* | get_max_lines_visible() | ++-----------+------------------------------+ Limits the lines of text the node shows on screen. @@ -194,11 +204,13 @@ Limits the lines of text the node shows on screen. - :ref:`float` **percent_visible** -+----------+----------------------------+ -| *Setter* | set_percent_visible(value) | -+----------+----------------------------+ -| *Getter* | get_percent_visible() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1.0 | ++-----------+----------------------------+ +| *Setter* | set_percent_visible(value) | ++-----------+----------------------------+ +| *Getter* | get_percent_visible() | ++-----------+----------------------------+ Limits the count of visible characters. If you set ``percent_visible`` to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. @@ -206,11 +218,13 @@ Limits the count of visible characters. If you set ``percent_visible`` to 50, on - :ref:`String` **text** -+----------+-----------------+ -| *Setter* | set_text(value) | -+----------+-----------------+ -| *Getter* | get_text() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | set_text(value) | ++-----------+-----------------+ +| *Getter* | get_text() | ++-----------+-----------------+ The text to display on screen. @@ -218,11 +232,13 @@ The text to display on screen. - :ref:`bool` **uppercase** -+----------+----------------------+ -| *Setter* | set_uppercase(value) | -+----------+----------------------+ -| *Getter* | is_uppercase() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_uppercase(value) | ++-----------+----------------------+ +| *Getter* | is_uppercase() | ++-----------+----------------------+ If ``true``, all the text displays as UPPERCASE. @@ -230,11 +246,13 @@ If ``true``, all the text displays as UPPERCASE. - :ref:`VAlign` **valign** -+----------+-------------------+ -| *Setter* | set_valign(value) | -+----------+-------------------+ -| *Getter* | get_valign() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0 | ++-----------+-------------------+ +| *Setter* | set_valign(value) | ++-----------+-------------------+ +| *Getter* | get_valign() | ++-----------+-------------------+ Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. @@ -242,11 +260,13 @@ Controls the text's vertical align. Supports top, center, bottom, and fill. Set - :ref:`int` **visible_characters** -+----------+-------------------------------+ -| *Setter* | set_visible_characters(value) | -+----------+-------------------------------+ -| *Getter* | get_visible_characters() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | -1 | ++-----------+-------------------------------+ +| *Setter* | set_visible_characters(value) | ++-----------+-------------------------------+ +| *Getter* | get_visible_characters() | ++-----------+-------------------------------+ Restricts the number of characters to display. Set to -1 to disable. diff --git a/classes/class_light.rst b/classes/class_light.rst index 9d343a151..543dba8d1 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -21,33 +21,33 @@ Provides a base class for different kinds of light nodes. Properties ---------- -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_only` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`BakeMode` | :ref:`light_bake_mode` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`light_color` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`light_cull_mask` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`light_energy` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`light_indirect_energy` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`light_negative` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`light_specular` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shadow_bias` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`shadow_color` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shadow_contact` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shadow_enabled` | -+--------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shadow_reverse_cull_face` | -+--------------------------------------+--------------------------------------------------------------------------------+ ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`editor_only` | false | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`BakeMode` | :ref:`light_bake_mode` | 1 | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`light_color` | Color( 1, 1, 1, 1 ) | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`light_cull_mask` | 4294967295 | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`light_energy` | 1.0 | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`light_indirect_energy` | 1.0 | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`light_negative` | false | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`light_specular` | 0.5 | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`shadow_bias` | 0.15 | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`shadow_color` | Color( 0, 0, 0, 1 ) | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`shadow_contact` | 0.0 | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`shadow_enabled` | false | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`shadow_reverse_cull_face` | false | ++--------------------------------------+--------------------------------------------------------------------------------+---------------------+ Enumerations ------------ @@ -157,23 +157,27 @@ Property Descriptions - :ref:`bool` **editor_only** -+----------+------------------------+ -| *Setter* | set_editor_only(value) | -+----------+------------------------+ -| *Getter* | is_editor_only() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_editor_only(value) | ++-----------+------------------------+ +| *Getter* | is_editor_only() | ++-----------+------------------------+ -If ``true``, the light only appears in the editor and will not be visible at runtime. Default value: ``false``. +If ``true``, the light only appears in the editor and will not be visible at runtime. .. _class_Light_property_light_bake_mode: - :ref:`BakeMode` **light_bake_mode** -+----------+----------------------+ -| *Setter* | set_bake_mode(value) | -+----------+----------------------+ -| *Getter* | get_bake_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1 | ++-----------+----------------------+ +| *Setter* | set_bake_mode(value) | ++-----------+----------------------+ +| *Getter* | get_bake_mode() | ++-----------+----------------------+ The light's bake mode. See :ref:`BakeMode`. @@ -181,11 +185,13 @@ The light's bake mode. See :ref:`BakeMode`. - :ref:`Color` **light_color** -+----------+------------------+ -| *Setter* | set_color(value) | -+----------+------------------+ -| *Getter* | get_color() | -+----------+------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_color(value) | ++-----------+---------------------+ +| *Getter* | get_color() | ++-----------+---------------------+ The light's color. @@ -193,11 +199,13 @@ The light's color. - :ref:`int` **light_cull_mask** -+----------+----------------------+ -| *Setter* | set_cull_mask(value) | -+----------+----------------------+ -| *Getter* | get_cull_mask() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 4294967295 | ++-----------+----------------------+ +| *Setter* | set_cull_mask(value) | ++-----------+----------------------+ +| *Getter* | get_cull_mask() | ++-----------+----------------------+ The light will affect objects in the selected layers. @@ -205,11 +213,13 @@ The light will affect objects in the selected layers. - :ref:`float` **light_energy** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The light's strength multiplier. @@ -217,11 +227,13 @@ The light's strength multiplier. - :ref:`float` **light_indirect_energy** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Secondary multiplier used with indirect light (light bounces). This works on both :ref:`BakedLightmap` and :ref:`GIProbe`. @@ -229,23 +241,27 @@ Secondary multiplier used with indirect light (light bounces). This works on bot - :ref:`bool` **light_negative** -+----------+---------------------+ -| *Setter* | set_negative(value) | -+----------+---------------------+ -| *Getter* | is_negative() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_negative(value) | ++-----------+---------------------+ +| *Getter* | is_negative() | ++-----------+---------------------+ -If ``true``, the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. +If ``true``, the light's effect is reversed, darkening areas and casting bright shadows. .. _class_Light_property_light_specular: - :ref:`float` **light_specular** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.5 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The intensity of the specular blob in objects affected by the light. At ``0`` the light becomes a pure diffuse light. @@ -253,11 +269,13 @@ The intensity of the specular blob in objects affected by the light. At ``0`` th - :ref:`float` **shadow_bias** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.15 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Used to adjust shadow appearance. Too small a value results in self-shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. @@ -265,11 +283,13 @@ Used to adjust shadow appearance. Too small a value results in self-shadowing, w - :ref:`Color` **shadow_color** -+----------+-------------------------+ -| *Setter* | set_shadow_color(value) | -+----------+-------------------------+ -| *Getter* | get_shadow_color() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Color( 0, 0, 0, 1 ) | ++-----------+-------------------------+ +| *Setter* | set_shadow_color(value) | ++-----------+-------------------------+ +| *Getter* | get_shadow_color() | ++-----------+-------------------------+ The color of shadows cast by this light. @@ -277,11 +297,13 @@ The color of shadows cast by this light. - :ref:`float` **shadow_contact** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Attempts to reduce :ref:`shadow_bias` gap. @@ -289,21 +311,25 @@ Attempts to reduce :ref:`shadow_bias` gap. - :ref:`bool` **shadow_enabled** -+----------+-------------------+ -| *Setter* | set_shadow(value) | -+----------+-------------------+ -| *Getter* | has_shadow() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_shadow(value) | ++-----------+-------------------+ +| *Getter* | has_shadow() | ++-----------+-------------------+ -If ``true``, the light will cast shadows. Default value: ``false``. +If ``true``, the light will cast shadows. .. _class_Light_property_shadow_reverse_cull_face: - :ref:`bool` **shadow_reverse_cull_face** -+----------+-------------------------------------+ -| *Setter* | set_shadow_reverse_cull_face(value) | -+----------+-------------------------------------+ -| *Getter* | get_shadow_reverse_cull_face() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | false | ++-----------+-------------------------------------+ +| *Setter* | set_shadow_reverse_cull_face(value) | ++-----------+-------------------------------------+ +| *Getter* | get_shadow_reverse_cull_face() | ++-----------+-------------------------------------+ diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 29b2ca305..7d4e113e1 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -19,49 +19,49 @@ Casts light in a 2D environment. Properties ---------- -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_only` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`energy` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`range_height` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_item_cull_mask` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_layer_max` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_layer_min` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_z_max` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_z_min` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_buffer_size` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`shadow_color` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shadow_enabled` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`ShadowFilter` | :ref:`shadow_filter` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shadow_filter_smooth` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shadow_gradient_length` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_item_cull_mask` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`texture_scale` | -+------------------------------------------------+------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`color` | Color( 1, 1, 1, 1 ) | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`editor_only` | false | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`enabled` | true | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`energy` | 1.0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`Mode` | :ref:`mode` | 0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`range_height` | 0.0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`range_item_cull_mask` | 1 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`range_layer_max` | 0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`range_layer_min` | 0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`range_z_max` | 1024 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`range_z_min` | -1024 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`shadow_buffer_size` | 2048 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`shadow_color` | Color( 0, 0, 0, 0 ) | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`shadow_enabled` | false | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`ShadowFilter` | :ref:`shadow_filter` | 0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`shadow_filter_smooth` | 0.0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`shadow_gradient_length` | 0.0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`shadow_item_cull_mask` | 1 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`texture_scale` | 1.0 | ++------------------------------------------------+------------------------------------------------------------------------------+---------------------+ Enumerations ------------ @@ -133,11 +133,13 @@ Property Descriptions - :ref:`Color` **color** -+----------+------------------+ -| *Setter* | set_color(value) | -+----------+------------------+ -| *Getter* | get_color() | -+----------+------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_color(value) | ++-----------+---------------------+ +| *Getter* | get_color() | ++-----------+---------------------+ The Light2D's :ref:`Color`. @@ -145,35 +147,41 @@ The Light2D's :ref:`Color`. - :ref:`bool` **editor_only** -+----------+------------------------+ -| *Setter* | set_editor_only(value) | -+----------+------------------------+ -| *Getter* | is_editor_only() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_editor_only(value) | ++-----------+------------------------+ +| *Getter* | is_editor_only() | ++-----------+------------------------+ -If ``true``, Light2D will only appear when editing the scene. Default value: ``false``. +If ``true``, Light2D will only appear when editing the scene. .. _class_Light2D_property_enabled: - :ref:`bool` **enabled** -+----------+--------------------+ -| *Setter* | set_enabled(value) | -+----------+--------------------+ -| *Getter* | is_enabled() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | true | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ -If ``true``, Light2D will emit light. Default value: ``true``. +If ``true``, Light2D will emit light. .. _class_Light2D_property_energy: - :ref:`float` **energy** -+----------+-------------------+ -| *Setter* | set_energy(value) | -+----------+-------------------+ -| *Getter* | get_energy() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_energy(value) | ++-----------+-------------------+ +| *Getter* | get_energy() | ++-----------+-------------------+ The Light2D's energy value. The larger the value, the stronger the light. @@ -181,11 +189,13 @@ The Light2D's energy value. The larger the value, the stronger the light. - :ref:`Mode` **mode** -+----------+-----------------+ -| *Setter* | set_mode(value) | -+----------+-----------------+ -| *Getter* | get_mode() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_mode(value) | ++-----------+-----------------+ +| *Getter* | get_mode() | ++-----------+-----------------+ The Light2D's mode. See ``MODE_*`` constants for values. @@ -193,11 +203,13 @@ The Light2D's mode. See ``MODE_*`` constants for values. - :ref:`Vector2` **offset** -+----------+---------------------------+ -| *Setter* | set_texture_offset(value) | -+----------+---------------------------+ -| *Getter* | get_texture_offset() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------------+ +| *Setter* | set_texture_offset(value) | ++-----------+---------------------------+ +| *Getter* | get_texture_offset() | ++-----------+---------------------------+ The offset of the Light2D's ``texture``. @@ -205,11 +217,13 @@ The offset of the Light2D's ``texture``. - :ref:`float` **range_height** -+----------+-------------------+ -| *Setter* | set_height(value) | -+----------+-------------------+ -| *Getter* | get_height() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.0 | ++-----------+-------------------+ +| *Setter* | set_height(value) | ++-----------+-------------------+ +| *Getter* | get_height() | ++-----------+-------------------+ The height of the Light2D. Used with 2D normal mapping. @@ -217,11 +231,13 @@ The height of the Light2D. Used with 2D normal mapping. - :ref:`int` **range_item_cull_mask** -+----------+---------------------------+ -| *Setter* | set_item_cull_mask(value) | -+----------+---------------------------+ -| *Getter* | get_item_cull_mask() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_item_cull_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_item_cull_mask() | ++-----------+---------------------------+ The layer mask. Only objects with a matching mask will be affected by the Light2D. @@ -229,71 +245,83 @@ The layer mask. Only objects with a matching mask will be affected by the Light2 - :ref:`int` **range_layer_max** -+----------+----------------------------+ -| *Setter* | set_layer_range_max(value) | -+----------+----------------------------+ -| *Getter* | get_layer_range_max() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_layer_range_max(value) | ++-----------+----------------------------+ +| *Getter* | get_layer_range_max() | ++-----------+----------------------------+ -Maximum layer value of objects that are affected by the Light2D. Default value: ``0``. +Maximum layer value of objects that are affected by the Light2D. .. _class_Light2D_property_range_layer_min: - :ref:`int` **range_layer_min** -+----------+----------------------------+ -| *Setter* | set_layer_range_min(value) | -+----------+----------------------------+ -| *Getter* | get_layer_range_min() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_layer_range_min(value) | ++-----------+----------------------------+ +| *Getter* | get_layer_range_min() | ++-----------+----------------------------+ -Minimum layer value of objects that are affected by the Light2D. Default value: ``0``. +Minimum layer value of objects that are affected by the Light2D. .. _class_Light2D_property_range_z_max: - :ref:`int` **range_z_max** -+----------+------------------------+ -| *Setter* | set_z_range_max(value) | -+----------+------------------------+ -| *Getter* | get_z_range_max() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1024 | ++-----------+------------------------+ +| *Setter* | set_z_range_max(value) | ++-----------+------------------------+ +| *Getter* | get_z_range_max() | ++-----------+------------------------+ -Maximum ``z`` value of objects that are affected by the Light2D. Default value: ``1024``. +Maximum ``z`` value of objects that are affected by the Light2D. .. _class_Light2D_property_range_z_min: - :ref:`int` **range_z_min** -+----------+------------------------+ -| *Setter* | set_z_range_min(value) | -+----------+------------------------+ -| *Getter* | get_z_range_min() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | -1024 | ++-----------+------------------------+ +| *Setter* | set_z_range_min(value) | ++-----------+------------------------+ +| *Getter* | get_z_range_min() | ++-----------+------------------------+ -Minimum ``z`` value of objects that are affected by the Light2D. Default value: ``-1024``. +Minimum ``z`` value of objects that are affected by the Light2D. .. _class_Light2D_property_shadow_buffer_size: - :ref:`int` **shadow_buffer_size** -+----------+-------------------------------+ -| *Setter* | set_shadow_buffer_size(value) | -+----------+-------------------------------+ -| *Getter* | get_shadow_buffer_size() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 2048 | ++-----------+-------------------------------+ +| *Setter* | set_shadow_buffer_size(value) | ++-----------+-------------------------------+ +| *Getter* | get_shadow_buffer_size() | ++-----------+-------------------------------+ -Shadow buffer size. Default value: ``2048``. +Shadow buffer size. .. _class_Light2D_property_shadow_color: - :ref:`Color` **shadow_color** -+----------+-------------------------+ -| *Setter* | set_shadow_color(value) | -+----------+-------------------------+ -| *Getter* | get_shadow_color() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Color( 0, 0, 0, 0 ) | ++-----------+-------------------------+ +| *Setter* | set_shadow_color(value) | ++-----------+-------------------------+ +| *Getter* | get_shadow_color() | ++-----------+-------------------------+ :ref:`Color` of shadows cast by the Light2D. @@ -301,35 +329,41 @@ Shadow buffer size. Default value: ``2048``. - :ref:`bool` **shadow_enabled** -+----------+---------------------------+ -| *Setter* | set_shadow_enabled(value) | -+----------+---------------------------+ -| *Getter* | is_shadow_enabled() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_shadow_enabled(value) | ++-----------+---------------------------+ +| *Getter* | is_shadow_enabled() | ++-----------+---------------------------+ -If ``true``, the Light2D will cast shadows. Default value: ``false``. +If ``true``, the Light2D will cast shadows. .. _class_Light2D_property_shadow_filter: - :ref:`ShadowFilter` **shadow_filter** -+----------+--------------------------+ -| *Setter* | set_shadow_filter(value) | -+----------+--------------------------+ -| *Getter* | get_shadow_filter() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_shadow_filter(value) | ++-----------+--------------------------+ +| *Getter* | get_shadow_filter() | ++-----------+--------------------------+ -Shadow filter type. See :ref:`ShadowFilter` for possible values. Default value: :ref:`SHADOW_FILTER_NONE`. +Shadow filter type. See :ref:`ShadowFilter` for possible values. .. _class_Light2D_property_shadow_filter_smooth: - :ref:`float` **shadow_filter_smooth** -+----------+--------------------------+ -| *Setter* | set_shadow_smooth(value) | -+----------+--------------------------+ -| *Getter* | get_shadow_smooth() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------+ +| *Setter* | set_shadow_smooth(value) | ++-----------+--------------------------+ +| *Getter* | get_shadow_smooth() | ++-----------+--------------------------+ Smoothing value for shadows. @@ -337,11 +371,13 @@ Smoothing value for shadows. - :ref:`float` **shadow_gradient_length** -+----------+-----------------------------------+ -| *Setter* | set_shadow_gradient_length(value) | -+----------+-----------------------------------+ -| *Getter* | get_shadow_gradient_length() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------------+ +| *Setter* | set_shadow_gradient_length(value) | ++-----------+-----------------------------------+ +| *Getter* | get_shadow_gradient_length() | ++-----------+-----------------------------------+ Smooth shadow gradient length. @@ -349,11 +385,13 @@ Smooth shadow gradient length. - :ref:`int` **shadow_item_cull_mask** -+----------+----------------------------------+ -| *Setter* | set_item_shadow_cull_mask(value) | -+----------+----------------------------------+ -| *Getter* | get_item_shadow_cull_mask() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 1 | ++-----------+----------------------------------+ +| *Setter* | set_item_shadow_cull_mask(value) | ++-----------+----------------------------------+ +| *Getter* | get_item_shadow_cull_mask() | ++-----------+----------------------------------+ The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. @@ -361,11 +399,13 @@ The shadow mask. Used with :ref:`LightOccluder2D` to cast - :ref:`Texture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ :ref:`Texture` used for the Light2D's appearance. @@ -373,11 +413,13 @@ The shadow mask. Used with :ref:`LightOccluder2D` to cast - :ref:`float` **texture_scale** -+----------+--------------------------+ -| *Setter* | set_texture_scale(value) | -+----------+--------------------------+ -| *Getter* | get_texture_scale() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_texture_scale(value) | ++-----------+--------------------------+ +| *Getter* | get_texture_scale() | ++-----------+--------------------------+ The ``texture``'s scale factor. diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index 12e3296d2..f122a112a 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -19,11 +19,11 @@ Occludes light cast by a Light2D, casting shadows. Properties ---------- -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`light_mask` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`occluder` | -+---------------------------------------------------+--------------------------------------------------------------+ ++---------------------------------------------------+--------------------------------------------------------------+------+ +| :ref:`int` | :ref:`light_mask` | 1 | ++---------------------------------------------------+--------------------------------------------------------------+------+ +| :ref:`OccluderPolygon2D` | :ref:`occluder` | null | ++---------------------------------------------------+--------------------------------------------------------------+------+ Description ----------- @@ -42,11 +42,13 @@ Property Descriptions - :ref:`int` **light_mask** -+----------+--------------------------------+ -| *Setter* | set_occluder_light_mask(value) | -+----------+--------------------------------+ -| *Getter* | get_occluder_light_mask() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 1 | ++-----------+--------------------------------+ +| *Setter* | set_occluder_light_mask(value) | ++-----------+--------------------------------+ +| *Getter* | get_occluder_light_mask() | ++-----------+--------------------------------+ The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). @@ -54,11 +56,13 @@ The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only fro - :ref:`OccluderPolygon2D` **occluder** -+----------+-----------------------------+ -| *Setter* | set_occluder_polygon(value) | -+----------+-----------------------------+ -| *Getter* | get_occluder_polygon() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | null | ++-----------+-----------------------------+ +| *Setter* | set_occluder_polygon(value) | ++-----------+-----------------------------+ +| *Getter* | get_occluder_polygon() | ++-----------+-----------------------------+ The :ref:`OccluderPolygon2D` used to compute the shadow. diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 67af954d0..aeaa7c3a3 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -19,29 +19,31 @@ A 2D line. Properties ---------- -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`LineCapMode` | :ref:`begin_cap_mode` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Color` | :ref:`default_color` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`LineCapMode` | :ref:`end_cap_mode` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`gradient` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`LineJointMode` | :ref:`joint_mode` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`points` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`round_precision` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`sharp_limit` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`LineTextureMode` | :ref:`texture_mode` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`width` | -+-----------------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`LineCapMode` | :ref:`begin_cap_mode` | 0 | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`default_color` | Color( 0.4, 0.5, 1, 1 ) | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`LineCapMode` | :ref:`end_cap_mode` | 0 | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Gradient` | :ref:`gradient` | null | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`LineJointMode` | :ref:`joint_mode` | 0 | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`PoolVector2Array` | :ref:`points` | PoolVector2Array( ) | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`round_precision` | 8 | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`sharp_limit` | 2.0 | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`LineTextureMode` | :ref:`texture_mode` | 0 | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`width` | 10.0 | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Curve` | :ref:`width_curve` | null | ++-----------------------------------------------------+---------------------------------------------------------------+-------------------------+ Methods ------- @@ -123,23 +125,27 @@ Property Descriptions - :ref:`LineCapMode` **begin_cap_mode** -+----------+---------------------------+ -| *Setter* | set_begin_cap_mode(value) | -+----------+---------------------------+ -| *Getter* | get_begin_cap_mode() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_begin_cap_mode(value) | ++-----------+---------------------------+ +| *Getter* | get_begin_cap_mode() | ++-----------+---------------------------+ -Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: :ref:`LINE_CAP_NONE`. +Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. .. _class_Line2D_property_default_color: - :ref:`Color` **default_color** -+----------+--------------------------+ -| *Setter* | set_default_color(value) | -+----------+--------------------------+ -| *Getter* | get_default_color() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Color( 0.4, 0.5, 1, 1 ) | ++-----------+--------------------------+ +| *Setter* | set_default_color(value) | ++-----------+--------------------------+ +| *Getter* | get_default_color() | ++-----------+--------------------------+ The line's color. Will not be used if a gradient is set. @@ -147,23 +153,27 @@ The line's color. Will not be used if a gradient is set. - :ref:`LineCapMode` **end_cap_mode** -+----------+-------------------------+ -| *Setter* | set_end_cap_mode(value) | -+----------+-------------------------+ -| *Getter* | get_end_cap_mode() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_end_cap_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_end_cap_mode() | ++-----------+-------------------------+ -Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: :ref:`LINE_CAP_NONE`. +Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. .. _class_Line2D_property_gradient: - :ref:`Gradient` **gradient** -+----------+---------------------+ -| *Setter* | set_gradient(value) | -+----------+---------------------+ -| *Getter* | get_gradient() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_gradient(value) | ++-----------+---------------------+ +| *Getter* | get_gradient() | ++-----------+---------------------+ The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. @@ -171,11 +181,13 @@ The gradient is drawn through the whole line from start to finish. The default c - :ref:`LineJointMode` **joint_mode** -+----------+-----------------------+ -| *Setter* | set_joint_mode(value) | -+----------+-----------------------+ -| *Getter* | get_joint_mode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_joint_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_joint_mode() | ++-----------+-----------------------+ The style for the points between the start and the end. @@ -183,11 +195,13 @@ The style for the points between the start and the end. - :ref:`PoolVector2Array` **points** -+----------+-------------------+ -| *Setter* | set_points(value) | -+----------+-------------------+ -| *Getter* | get_points() | -+----------+-------------------+ ++-----------+----------------------+ +| *Default* | PoolVector2Array( ) | ++-----------+----------------------+ +| *Setter* | set_points(value) | ++-----------+----------------------+ +| *Getter* | get_points() | ++-----------+----------------------+ The points that form the lines. The line is drawn between every point set in this array. @@ -195,11 +209,13 @@ The points that form the lines. The line is drawn between every point set in thi - :ref:`int` **round_precision** -+----------+----------------------------+ -| *Setter* | set_round_precision(value) | -+----------+----------------------------+ -| *Getter* | get_round_precision() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 8 | ++-----------+----------------------------+ +| *Setter* | set_round_precision(value) | ++-----------+----------------------------+ +| *Getter* | get_round_precision() | ++-----------+----------------------------+ The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. @@ -207,11 +223,13 @@ The smoothness of the rounded joints and caps. This is only used if a cap or joi - :ref:`float` **sharp_limit** -+----------+------------------------+ -| *Setter* | set_sharp_limit(value) | -+----------+------------------------+ -| *Getter* | get_sharp_limit() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 2.0 | ++-----------+------------------------+ +| *Setter* | set_sharp_limit(value) | ++-----------+------------------------+ +| *Getter* | get_sharp_limit() | ++-----------+------------------------+ The direction difference in radians between vector points. This value is only used if ``joint mode`` is set to :ref:`LINE_JOINT_SHARP`. @@ -219,11 +237,13 @@ The direction difference in radians between vector points. This value is only us - :ref:`Texture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ The texture used for the line's texture. Uses ``texture_mode`` for drawing style. @@ -231,26 +251,44 @@ The texture used for the line's texture. Uses ``texture_mode`` for drawing style - :ref:`LineTextureMode` **texture_mode** -+----------+-------------------------+ -| *Setter* | set_texture_mode(value) | -+----------+-------------------------+ -| *Getter* | get_texture_mode() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_texture_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_texture_mode() | ++-----------+-------------------------+ -The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: :ref:`LINE_TEXTURE_NONE`. +The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. .. _class_Line2D_property_width: - :ref:`float` **width** -+----------+------------------+ -| *Setter* | set_width(value) | -+----------+------------------+ -| *Getter* | get_width() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 10.0 | ++-----------+------------------+ +| *Setter* | set_width(value) | ++-----------+------------------+ +| *Getter* | get_width() | ++-----------+------------------+ The line's width. +.. _class_Line2D_property_width_curve: + +- :ref:`Curve` **width_curve** + ++-----------+------------------+ +| *Default* | null | ++-----------+------------------+ +| *Setter* | set_curve(value) | ++-----------+------------------+ +| *Getter* | get_curve() | ++-----------+------------------+ + +The line's width varies with the curve. The original width is simply multiply by the value of the Curve. + Method Descriptions ------------------- diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index e52e63497..5c351690b 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -19,37 +19,37 @@ Control that provides single-line string editing. Properties ---------- -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Align` | :ref:`align` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`caret_blink` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`caret_blink_speed` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`caret_position` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`clear_button_enabled` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`context_menu_enabled` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editable` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`expand_to_text_length` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`focus_mode` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_length` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`placeholder_alpha` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`placeholder_text` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`secret` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`secret_character` | -+------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+------------------------------------------+-----------------------------------------------------------------------------+ ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`Align` | :ref:`align` | 0 | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`caret_blink` | false | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`caret_blink_speed` | 0.65 | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`caret_position` | 0 | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`clear_button_enabled` | false | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`context_menu_enabled` | true | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`editable` | true | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`expand_to_text_length` | false | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`FocusMode` | :ref:`focus_mode` | 2 | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`max_length` | 0 | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`placeholder_alpha` | 0.6 | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`placeholder_text` | "" | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`secret` | false | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`secret_character` | "*" | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`text` | "" | ++------------------------------------------+-----------------------------------------------------------------------------+-------+ Methods ------- @@ -73,33 +73,33 @@ Methods Theme Properties ---------------- -+---------------------------------+----------------------------+ -| :ref:`Texture` | clear | -+---------------------------------+----------------------------+ -| :ref:`Color` | clear_button_color | -+---------------------------------+----------------------------+ -| :ref:`Color` | clear_button_color_pressed | -+---------------------------------+----------------------------+ -| :ref:`Color` | cursor_color | -+---------------------------------+----------------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+----------------------------+ -| :ref:`Font` | font | -+---------------------------------+----------------------------+ -| :ref:`Color` | font_color | -+---------------------------------+----------------------------+ -| :ref:`Color` | font_color_selected | -+---------------------------------+----------------------------+ -| :ref:`Color` | font_color_uneditable | -+---------------------------------+----------------------------+ -| :ref:`int` | minimum_spaces | -+---------------------------------+----------------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+----------------------------+ -| :ref:`StyleBox` | read_only | -+---------------------------------+----------------------------+ -| :ref:`Color` | selection_color | -+---------------------------------+----------------------------+ ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Texture` | clear | | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Color` | clear_button_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Color` | clear_button_color_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Color` | cursor_color | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Color` | font_color_selected | Color( 0, 0, 0, 1 ) | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Color` | font_color_uneditable | Color( 0.878431, 0.878431, 0.878431, 0.5 ) | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`int` | minimum_spaces | 12 | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`StyleBox` | read_only | | ++---------------------------------+----------------------------+--------------------------------------------+ +| :ref:`Color` | selection_color | Color( 0.490196, 0.490196, 0.490196, 1 ) | ++---------------------------------+----------------------------+--------------------------------------------+ Signals ------- @@ -207,11 +207,13 @@ Property Descriptions - :ref:`Align` **align** -+----------+------------------+ -| *Setter* | set_align(value) | -+----------+------------------+ -| *Getter* | get_align() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_align(value) | ++-----------+------------------+ +| *Getter* | get_align() | ++-----------+------------------+ Text alignment as defined in the ``ALIGN_*`` enum. @@ -219,11 +221,13 @@ Text alignment as defined in the ``ALIGN_*`` enum. - :ref:`bool` **caret_blink** -+----------+---------------------------------+ -| *Setter* | cursor_set_blink_enabled(value) | -+----------+---------------------------------+ -| *Getter* | cursor_get_blink_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | cursor_set_blink_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | cursor_get_blink_enabled() | ++-----------+---------------------------------+ If ``true``, the caret (visual cursor) blinks. @@ -231,11 +235,13 @@ If ``true``, the caret (visual cursor) blinks. - :ref:`float` **caret_blink_speed** -+----------+-------------------------------+ -| *Setter* | cursor_set_blink_speed(value) | -+----------+-------------------------------+ -| *Getter* | cursor_get_blink_speed() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.65 | ++-----------+-------------------------------+ +| *Setter* | cursor_set_blink_speed(value) | ++-----------+-------------------------------+ +| *Getter* | cursor_get_blink_speed() | ++-----------+-------------------------------+ Duration (in seconds) of a caret's blinking cycle. @@ -243,11 +249,13 @@ Duration (in seconds) of a caret's blinking cycle. - :ref:`int` **caret_position** -+----------+----------------------------+ -| *Setter* | set_cursor_position(value) | -+----------+----------------------------+ -| *Getter* | get_cursor_position() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_cursor_position(value) | ++-----------+----------------------------+ +| *Getter* | get_cursor_position() | ++-----------+----------------------------+ The cursor's position inside the ``LineEdit``. When set, the text may scroll to accommodate it. @@ -255,11 +263,13 @@ The cursor's position inside the ``LineEdit``. When set, the text may scroll to - :ref:`bool` **clear_button_enabled** -+----------+---------------------------------+ -| *Setter* | set_clear_button_enabled(value) | -+----------+---------------------------------+ -| *Getter* | is_clear_button_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_clear_button_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | is_clear_button_enabled() | ++-----------+---------------------------------+ If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty. @@ -267,11 +277,13 @@ If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty. - :ref:`bool` **context_menu_enabled** -+----------+---------------------------------+ -| *Setter* | set_context_menu_enabled(value) | -+----------+---------------------------------+ -| *Getter* | is_context_menu_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | true | ++-----------+---------------------------------+ +| *Setter* | set_context_menu_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | is_context_menu_enabled() | ++-----------+---------------------------------+ If ``true``, the context menu will appear when right-clicked. @@ -279,11 +291,13 @@ If ``true``, the context menu will appear when right-clicked. - :ref:`bool` **editable** -+----------+---------------------+ -| *Setter* | set_editable(value) | -+----------+---------------------+ -| *Getter* | is_editable() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_editable(value) | ++-----------+---------------------+ +| *Getter* | is_editable() | ++-----------+---------------------+ If ``false``, existing text cannot be modified and new text cannot be added. @@ -291,11 +305,13 @@ If ``false``, existing text cannot be modified and new text cannot be added. - :ref:`bool` **expand_to_text_length** -+----------+----------------------------------+ -| *Setter* | set_expand_to_text_length(value) | -+----------+----------------------------------+ -| *Getter* | get_expand_to_text_length() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_expand_to_text_length(value) | ++-----------+----------------------------------+ +| *Getter* | get_expand_to_text_length() | ++-----------+----------------------------------+ If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. @@ -303,11 +319,13 @@ If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:` - :ref:`FocusMode` **focus_mode** -+----------+-----------------------+ -| *Setter* | set_focus_mode(value) | -+----------+-----------------------+ -| *Getter* | get_focus_mode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 2 | ++-----------+-----------------------+ +| *Setter* | set_focus_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_focus_mode() | ++-----------+-----------------------+ Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, or none). See :ref:`FocusMode` for details. @@ -315,11 +333,13 @@ Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, - :ref:`int` **max_length** -+----------+-----------------------+ -| *Setter* | set_max_length(value) | -+----------+-----------------------+ -| *Getter* | get_max_length() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_max_length(value) | ++-----------+-----------------------+ +| *Getter* | get_max_length() | ++-----------+-----------------------+ Maximum amount of characters that can be entered inside the ``LineEdit``. If ``0``, there is no limit. @@ -327,11 +347,13 @@ Maximum amount of characters that can be entered inside the ``LineEdit``. If ``0 - :ref:`float` **placeholder_alpha** -+----------+------------------------------+ -| *Setter* | set_placeholder_alpha(value) | -+----------+------------------------------+ -| *Getter* | get_placeholder_alpha() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | 0.6 | ++-----------+------------------------------+ +| *Setter* | set_placeholder_alpha(value) | ++-----------+------------------------------+ +| *Getter* | get_placeholder_alpha() | ++-----------+------------------------------+ Opacity of the :ref:`placeholder_text`. From ``0`` to ``1``. @@ -339,11 +361,13 @@ Opacity of the :ref:`placeholder_text` - :ref:`String` **placeholder_text** -+----------+------------------------+ -| *Setter* | set_placeholder(value) | -+----------+------------------------+ -| *Getter* | get_placeholder() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | "" | ++-----------+------------------------+ +| *Setter* | set_placeholder(value) | ++-----------+------------------------+ +| *Getter* | get_placeholder() | ++-----------+------------------------+ Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s default value (see :ref:`text`). @@ -351,11 +375,13 @@ Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s defa - :ref:`bool` **secret** -+----------+-------------------+ -| *Setter* | set_secret(value) | -+----------+-------------------+ -| *Getter* | is_secret() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_secret(value) | ++-----------+-------------------+ +| *Getter* | is_secret() | ++-----------+-------------------+ If ``true``, every character is replaced with the secret character (see :ref:`secret_character`). @@ -363,11 +389,13 @@ If ``true``, every character is replaced with the secret character (see :ref:`se - :ref:`String` **secret_character** -+----------+-----------------------------+ -| *Setter* | set_secret_character(value) | -+----------+-----------------------------+ -| *Getter* | get_secret_character() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | "*" | ++-----------+-----------------------------+ +| *Setter* | set_secret_character(value) | ++-----------+-----------------------------+ +| *Getter* | get_secret_character() | ++-----------+-----------------------------+ The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. @@ -375,11 +403,13 @@ The character to use to mask secret input (defaults to "\*"). Only a single char - :ref:`String` **text** -+----------+-----------------+ -| *Setter* | set_text(value) | -+----------+-----------------+ -| *Getter* | get_text() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | set_text(value) | ++-----------+-----------------+ +| *Getter* | get_text() | ++-----------+-----------------+ String value of the ``LineEdit``. diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 7844e9cf3..28aa530cc 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -19,11 +19,11 @@ Line shape for 2D collisions. Properties ---------- -+-------------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`d` | -+-------------------------------+--------------------------------------------------+ -| :ref:`Vector2` | :ref:`normal` | -+-------------------------------+--------------------------------------------------+ ++-------------------------------+--------------------------------------------------+------------------+ +| :ref:`float` | :ref:`d` | 0.0 | ++-------------------------------+--------------------------------------------------+------------------+ +| :ref:`Vector2` | :ref:`normal` | Vector2( 0, -1 ) | ++-------------------------------+--------------------------------------------------+------------------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`float` **d** -+----------+--------------+ -| *Setter* | set_d(value) | -+----------+--------------+ -| *Getter* | get_d() | -+----------+--------------+ ++-----------+--------------+ +| *Default* | 0.0 | ++-----------+--------------+ +| *Setter* | set_d(value) | ++-----------+--------------+ +| *Getter* | get_d() | ++-----------+--------------+ The line's distance from the origin. @@ -49,11 +51,13 @@ The line's distance from the origin. - :ref:`Vector2` **normal** -+----------+-------------------+ -| *Setter* | set_normal(value) | -+----------+-------------------+ -| *Getter* | get_normal() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | Vector2( 0, -1 ) | ++-----------+-------------------+ +| *Setter* | set_normal(value) | ++-----------+-------------------+ +| *Getter* | get_normal() | ++-----------+-------------------+ The line's normal. diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index aff0d8d30..b66a54f40 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -19,28 +19,28 @@ Simple button used to represent a link to some resource. Properties ---------- -+-----------------------------------------------------+-------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+-----------------------------------------------------+-------------------------------------------------------+ -| :ref:`UnderlineMode` | :ref:`underline` | -+-----------------------------------------------------+-------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------+----+ +| :ref:`String` | :ref:`text` | "" | ++-----------------------------------------------------+-------------------------------------------------------+----+ +| :ref:`UnderlineMode` | :ref:`underline` | 0 | ++-----------------------------------------------------+-------------------------------------------------------+----+ Theme Properties ---------------- -+---------------------------------+--------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+--------------------+ -| :ref:`Font` | font | -+---------------------------------+--------------------+ -| :ref:`Color` | font_color | -+---------------------------------+--------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+--------------------+ -| :ref:`Color` | font_color_pressed | -+---------------------------------+--------------------+ -| :ref:`int` | underline_spacing | -+---------------------------------+--------------------+ ++---------------------------------+--------------------+------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+--------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+--------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+--------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+--------------------+------------------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+--------------------+------------------------------------------+ +| :ref:`int` | underline_spacing | 2 | ++---------------------------------+--------------------+------------------------------------------+ Enumerations ------------ @@ -73,19 +73,23 @@ Property Descriptions - :ref:`String` **text** -+----------+-----------------+ -| *Setter* | set_text(value) | -+----------+-----------------+ -| *Getter* | get_text() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | set_text(value) | ++-----------+-----------------+ +| *Getter* | get_text() | ++-----------+-----------------+ .. _class_LinkButton_property_underline: - :ref:`UnderlineMode` **underline** -+----------+---------------------------+ -| *Setter* | set_underline_mode(value) | -+----------+---------------------------+ -| *Getter* | get_underline_mode() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_underline_mode(value) | ++-----------+---------------------------+ +| *Getter* | get_underline_mode() | ++-----------+---------------------------+ diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 2f550ec70..fc64d1dae 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -19,15 +19,15 @@ Simple margin container. Theme Properties ---------------- -+-----------------------+---------------+ -| :ref:`int` | margin_bottom | -+-----------------------+---------------+ -| :ref:`int` | margin_left | -+-----------------------+---------------+ -| :ref:`int` | margin_right | -+-----------------------+---------------+ -| :ref:`int` | margin_top | -+-----------------------+---------------+ ++-----------------------+---------------+---+ +| :ref:`int` | margin_bottom | 0 | ++-----------------------+---------------+---+ +| :ref:`int` | margin_left | 0 | ++-----------------------+---------------+---+ +| :ref:`int` | margin_right | 0 | ++-----------------------+---------------+---+ +| :ref:`int` | margin_top | 0 | ++-----------------------+---------------+---+ Description ----------- diff --git a/classes/class_material.rst b/classes/class_material.rst index d5319bfef..0e36fba2c 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -21,11 +21,11 @@ Abstract base :ref:`Resource` for coloring and shading geometry. Properties ---------- -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`Material` | :ref:`next_pass` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`render_priority` | -+---------------------------------+-----------------------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------------+------+ +| :ref:`Material` | :ref:`next_pass` | null | ++---------------------------------+-----------------------------------------------------------------+------+ +| :ref:`int` | :ref:`render_priority` | 0 | ++---------------------------------+-----------------------------------------------------------------+------+ Constants --------- @@ -50,19 +50,23 @@ Property Descriptions - :ref:`Material` **next_pass** -+----------+----------------------+ -| *Setter* | set_next_pass(value) | -+----------+----------------------+ -| *Getter* | get_next_pass() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | null | ++-----------+----------------------+ +| *Setter* | set_next_pass(value) | ++-----------+----------------------+ +| *Getter* | get_next_pass() | ++-----------+----------------------+ .. _class_Material_property_render_priority: - :ref:`int` **render_priority** -+----------+----------------------------+ -| *Setter* | set_render_priority(value) | -+----------+----------------------------+ -| *Getter* | get_render_priority() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_render_priority(value) | ++-----------+----------------------------+ +| *Getter* | get_render_priority() | ++-----------+----------------------------+ diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 16701f758..93a9ab564 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -19,9 +19,9 @@ Special button that brings up a :ref:`PopupMenu` when clicked. Properties ---------- -+-------------------------+-------------------------------------------------------------------+ -| :ref:`bool` | :ref:`switch_on_hover` | -+-------------------------+-------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`switch_on_hover` | false | ++-------------------------+-------------------------------------------------------------------+-------+ Methods ------- @@ -35,29 +35,29 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`StyleBox` | disabled | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+---------------------+ -| :ref:`Font` | font | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_pressed | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | hover | -+---------------------------------+---------------------+ -| :ref:`int` | hseparation | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | pressed | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | disabled | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 1, 1, 1, 0.3 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | hover | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | hseparation | 3 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | pressed | | ++---------------------------------+---------------------+------------------------------------------+ Signals ------- @@ -80,11 +80,13 @@ Property Descriptions - :ref:`bool` **switch_on_hover** -+----------+----------------------------+ -| *Setter* | set_switch_on_hover(value) | -+----------+----------------------------+ -| *Getter* | is_switch_on_hover() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | false | ++-----------+----------------------------+ +| *Setter* | set_switch_on_hover(value) | ++-----------+----------------------------+ +| *Getter* | is_switch_on_hover() | ++-----------+----------------------------+ If ``true``, when the cursor hovers above another MenuButton within the same parent which also has ``switch_on_hover`` enabled, it will close the current MenuButton and open the other one. diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 22a46753b..e5f8950c4 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -21,9 +21,9 @@ A :ref:`Resource` that contains vertex array-based geometry. Properties ---------- -+-------------------------------+-------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`lightmap_size_hint` | -+-------------------------------+-------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`lightmap_size_hint` | Vector2( 0, 0 ) | ++-------------------------------+-------------------------------------------------------------------+-----------------+ Methods ------- @@ -245,11 +245,13 @@ Property Descriptions - :ref:`Vector2` **lightmap_size_hint** -+----------+-------------------------------+ -| *Setter* | set_lightmap_size_hint(value) | -+----------+-------------------------------+ -| *Getter* | get_lightmap_size_hint() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------------------+ +| *Setter* | set_lightmap_size_hint(value) | ++-----------+-------------------------------+ +| *Getter* | get_lightmap_size_hint() | ++-----------+-------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 6222c6410..d9c133ee9 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -21,11 +21,11 @@ Node that instances meshes into a scenario. Properties ---------- -+---------------------------------+-------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+---------------------------------+-------------------------------------------------------+ -| :ref:`NodePath` | :ref:`skeleton` | -+---------------------------------+-------------------------------------------------------+ ++---------------------------------+-------------------------------------------------------+----------------+ +| :ref:`Mesh` | :ref:`mesh` | null | ++---------------------------------+-------------------------------------------------------+----------------+ +| :ref:`NodePath` | :ref:`skeleton` | NodePath("..") | ++---------------------------------+-------------------------------------------------------+----------------+ Methods ------- @@ -56,11 +56,13 @@ Property Descriptions - :ref:`Mesh` **mesh** -+----------+-----------------+ -| *Setter* | set_mesh(value) | -+----------+-----------------+ -| *Getter* | get_mesh() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | null | ++-----------+-----------------+ +| *Setter* | set_mesh(value) | ++-----------+-----------------+ +| *Getter* | get_mesh() | ++-----------+-----------------+ The :ref:`Mesh` resource for the instance. @@ -68,11 +70,13 @@ The :ref:`Mesh` resource for the instance. - :ref:`NodePath` **skeleton** -+----------+--------------------------+ -| *Setter* | set_skeleton_path(value) | -+----------+--------------------------+ -| *Getter* | get_skeleton_path() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | NodePath("..") | ++-----------+--------------------------+ +| *Setter* | set_skeleton_path(value) | ++-----------+--------------------------+ +| *Getter* | get_skeleton_path() | ++-----------+--------------------------+ :ref:`NodePath` to the :ref:`Skeleton` associated with the instance. diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 1adf61fc9..930d2b7a4 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -19,13 +19,13 @@ Node used for displaying a :ref:`Mesh` in 2D. Properties ---------- -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------+-------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------+------+ +| :ref:`Mesh` | :ref:`mesh` | null | ++-------------------------------+-------------------------------------------------------------+------+ +| :ref:`Texture` | :ref:`normal_map` | null | ++-------------------------------+-------------------------------------------------------------+------+ +| :ref:`Texture` | :ref:`texture` | null | ++-------------------------------+-------------------------------------------------------------+------+ Signals ------- @@ -51,11 +51,13 @@ Property Descriptions - :ref:`Mesh` **mesh** -+----------+-----------------+ -| *Setter* | set_mesh(value) | -+----------+-----------------+ -| *Getter* | get_mesh() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | null | ++-----------+-----------------+ +| *Setter* | set_mesh(value) | ++-----------+-----------------+ +| *Getter* | get_mesh() | ++-----------+-----------------+ The :ref:`Mesh` that will be drawn by the ``MeshInstance2D``. @@ -63,11 +65,13 @@ The :ref:`Mesh` that will be drawn by the ``MeshInstance2D``. - :ref:`Texture` **normal_map** -+----------+-----------------------+ -| *Setter* | set_normal_map(value) | -+----------+-----------------------+ -| *Getter* | get_normal_map() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++-----------+-----------------------+ +| *Getter* | get_normal_map() | ++-----------+-----------------------+ The normal map that will be used if using the default :ref:`CanvasItemMaterial`. @@ -75,11 +79,13 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ The :ref:`Texture` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index 7356e1077..0c1076b17 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -19,13 +19,13 @@ Simple texture that uses a mesh to draw itself. Properties ---------- -+-------------------------------+--------------------------------------------------------------+ -| :ref:`Texture` | :ref:`base_texture` | -+-------------------------------+--------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`image_size` | -+-------------------------------+--------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+-------------------------------+--------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------+-----------------+ +| :ref:`Texture` | :ref:`base_texture` | null | ++-------------------------------+--------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`image_size` | Vector2( 0, 0 ) | ++-------------------------------+--------------------------------------------------------------+-----------------+ +| :ref:`Mesh` | :ref:`mesh` | null | ++-------------------------------+--------------------------------------------------------------+-----------------+ Description ----------- @@ -39,11 +39,13 @@ Property Descriptions - :ref:`Texture` **base_texture** -+----------+-------------------------+ -| *Setter* | set_base_texture(value) | -+----------+-------------------------+ -| *Getter* | get_base_texture() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | null | ++-----------+-------------------------+ +| *Setter* | set_base_texture(value) | ++-----------+-------------------------+ +| *Getter* | get_base_texture() | ++-----------+-------------------------+ Sets the base texture that the Mesh will use to draw. @@ -51,11 +53,13 @@ Sets the base texture that the Mesh will use to draw. - :ref:`Vector2` **image_size** -+----------+-----------------------+ -| *Setter* | set_image_size(value) | -+----------+-----------------------+ -| *Getter* | get_image_size() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------------+ +| *Setter* | set_image_size(value) | ++-----------+-----------------------+ +| *Getter* | get_image_size() | ++-----------+-----------------------+ Sets the size of the image, needed for reference. @@ -63,11 +67,13 @@ Sets the size of the image, needed for reference. - :ref:`Mesh` **mesh** -+----------+-----------------+ -| *Setter* | set_mesh(value) | -+----------+-----------------+ -| *Getter* | get_mesh() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | null | ++-----------+-----------------+ +| *Setter* | set_mesh(value) | ++-----------+-----------------+ +| *Getter* | get_mesh() | ++-----------+-----------------+ Sets the mesh used to draw. It must be a mesh using 2D vertices. diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index eca5091d8..de6038951 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -19,21 +19,21 @@ Generic mobile VR implementation. Properties ---------- -+---------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`display_to_lens` | -+---------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`display_width` | -+---------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`eye_height` | -+---------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`iod` | -+---------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`k1` | -+---------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`k2` | -+---------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oversample` | -+---------------------------+--------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`display_to_lens` | 4.0 | ++---------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`display_width` | 14.5 | ++---------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`eye_height` | 1.85 | ++---------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`iod` | 6.0 | ++---------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`k1` | 0.215 | ++---------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`k2` | 0.215 | ++---------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`oversample` | 1.5 | ++---------------------------+--------------------------------------------------------------------------+-------+ Description ----------- @@ -57,11 +57,13 @@ Property Descriptions - :ref:`float` **display_to_lens** -+----------+----------------------------+ -| *Setter* | set_display_to_lens(value) | -+----------+----------------------------+ -| *Getter* | get_display_to_lens() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 4.0 | ++-----------+----------------------------+ +| *Setter* | set_display_to_lens(value) | ++-----------+----------------------------+ +| *Getter* | get_display_to_lens() | ++-----------+----------------------------+ The distance between the display and the lenses inside of the device in centimeters. @@ -69,11 +71,13 @@ The distance between the display and the lenses inside of the device in centimet - :ref:`float` **display_width** -+----------+--------------------------+ -| *Setter* | set_display_width(value) | -+----------+--------------------------+ -| *Getter* | get_display_width() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 14.5 | ++-----------+--------------------------+ +| *Setter* | set_display_width(value) | ++-----------+--------------------------+ +| *Getter* | get_display_width() | ++-----------+--------------------------+ The width of the display in centimeters. @@ -81,11 +85,13 @@ The width of the display in centimeters. - :ref:`float` **eye_height** -+----------+-----------------------+ -| *Setter* | set_eye_height(value) | -+----------+-----------------------+ -| *Getter* | get_eye_height() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.85 | ++-----------+-----------------------+ +| *Setter* | set_eye_height(value) | ++-----------+-----------------------+ +| *Getter* | get_eye_height() | ++-----------+-----------------------+ The height at which the camera is placed in relation to the ground (i.e. :ref:`ARVROrigin` node). @@ -93,11 +99,13 @@ The height at which the camera is placed in relation to the ground (i.e. :ref:`A - :ref:`float` **iod** -+----------+----------------+ -| *Setter* | set_iod(value) | -+----------+----------------+ -| *Getter* | get_iod() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | 6.0 | ++-----------+----------------+ +| *Setter* | set_iod(value) | ++-----------+----------------+ +| *Getter* | get_iod() | ++-----------+----------------+ The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. @@ -105,11 +113,13 @@ The interocular distance, also known as the interpupillary distance. The distanc - :ref:`float` **k1** -+----------+---------------+ -| *Setter* | set_k1(value) | -+----------+---------------+ -| *Getter* | get_k1() | -+----------+---------------+ ++-----------+---------------+ +| *Default* | 0.215 | ++-----------+---------------+ +| *Setter* | set_k1(value) | ++-----------+---------------+ +| *Getter* | get_k1() | ++-----------+---------------+ The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect. @@ -117,11 +127,13 @@ The k1 lens factor is one of the two constants that define the strength of the l - :ref:`float` **k2** -+----------+---------------+ -| *Setter* | set_k2(value) | -+----------+---------------+ -| *Getter* | get_k2() | -+----------+---------------+ ++-----------+---------------+ +| *Default* | 0.215 | ++-----------+---------------+ +| *Setter* | set_k2(value) | ++-----------+---------------+ +| *Getter* | get_k2() | ++-----------+---------------+ The k2 lens factor, see k1. @@ -129,11 +141,13 @@ The k2 lens factor, see k1. - :ref:`float` **oversample** -+----------+-----------------------+ -| *Setter* | set_oversample(value) | -+----------+-----------------------+ -| *Getter* | get_oversample() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.5 | ++-----------+-----------------------+ +| *Setter* | set_oversample(value) | ++-----------+-----------------------+ +| *Getter* | get_oversample() | ++-----------+-----------------------+ The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index af206f7b9..0cd8ec472 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -19,19 +19,19 @@ Provides high-performance mesh instancing. Properties ---------- -+----------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`ColorFormat` | :ref:`color_format` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`CustomDataFormat` | :ref:`custom_data_format` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`instance_count` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`TransformFormat` | :ref:`transform_format` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`visible_instance_count` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+ ++----------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`ColorFormat` | :ref:`color_format` | 0 | ++----------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`CustomDataFormat` | :ref:`custom_data_format` | 0 | ++----------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`instance_count` | 0 | ++----------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`Mesh` | :ref:`mesh` | null | ++----------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`TransformFormat` | :ref:`transform_format` | 0 | ++----------------------------------------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`visible_instance_count` | -1 | ++----------------------------------------------------------+--------------------------------------------------------------------------------+------+ Methods ------- @@ -128,11 +128,13 @@ Property Descriptions - :ref:`ColorFormat` **color_format** -+----------+-------------------------+ -| *Setter* | set_color_format(value) | -+----------+-------------------------+ -| *Getter* | get_color_format() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_color_format(value) | ++-----------+-------------------------+ +| *Getter* | get_color_format() | ++-----------+-------------------------+ Format of colors in color array that gets passed to shader. @@ -140,11 +142,13 @@ Format of colors in color array that gets passed to shader. - :ref:`CustomDataFormat` **custom_data_format** -+----------+-------------------------------+ -| *Setter* | set_custom_data_format(value) | -+----------+-------------------------------+ -| *Getter* | get_custom_data_format() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0 | ++-----------+-------------------------------+ +| *Setter* | set_custom_data_format(value) | ++-----------+-------------------------------+ +| *Getter* | get_custom_data_format() | ++-----------+-------------------------------+ Format of custom data in custom data array that gets passed to shader. @@ -152,11 +156,13 @@ Format of custom data in custom data array that gets passed to shader. - :ref:`int` **instance_count** -+----------+---------------------------+ -| *Setter* | set_instance_count(value) | -+----------+---------------------------+ -| *Getter* | get_instance_count() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_instance_count(value) | ++-----------+---------------------------+ +| *Getter* | get_instance_count() | ++-----------+---------------------------+ Number of instances that will get drawn. This clears and (re)sizes the buffers. By default, all instances are drawn but you can limit this with :ref:`visible_instance_count`. @@ -164,11 +170,13 @@ Number of instances that will get drawn. This clears and (re)sizes the buffers. - :ref:`Mesh` **mesh** -+----------+-----------------+ -| *Setter* | set_mesh(value) | -+----------+-----------------+ -| *Getter* | get_mesh() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | null | ++-----------+-----------------+ +| *Setter* | set_mesh(value) | ++-----------+-----------------+ +| *Getter* | get_mesh() | ++-----------+-----------------+ Mesh to be drawn. @@ -176,11 +184,13 @@ Mesh to be drawn. - :ref:`TransformFormat` **transform_format** -+----------+-----------------------------+ -| *Setter* | set_transform_format(value) | -+----------+-----------------------------+ -| *Getter* | get_transform_format() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0 | ++-----------+-----------------------------+ +| *Setter* | set_transform_format(value) | ++-----------+-----------------------------+ +| *Getter* | get_transform_format() | ++-----------+-----------------------------+ Format of transform used to transform mesh, either 2D or 3D. @@ -188,11 +198,13 @@ Format of transform used to transform mesh, either 2D or 3D. - :ref:`int` **visible_instance_count** -+----------+-----------------------------------+ -| *Setter* | set_visible_instance_count(value) | -+----------+-----------------------------------+ -| *Getter* | get_visible_instance_count() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | -1 | ++-----------+-----------------------------------+ +| *Setter* | set_visible_instance_count(value) | ++-----------+-----------------------------------+ +| *Getter* | get_visible_instance_count() | ++-----------+-----------------------------------+ Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers. diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index 43a7cfcc6..fce0efc7b 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -19,9 +19,9 @@ Node that instances a :ref:`MultiMesh`. Properties ---------- -+-----------------------------------+--------------------------------------------------------------+ -| :ref:`MultiMesh` | :ref:`multimesh` | -+-----------------------------------+--------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------+------+ +| :ref:`MultiMesh` | :ref:`multimesh` | null | ++-----------------------------------+--------------------------------------------------------------+------+ Description ----------- @@ -44,11 +44,13 @@ Property Descriptions - :ref:`MultiMesh` **multimesh** -+----------+----------------------+ -| *Setter* | set_multimesh(value) | -+----------+----------------------+ -| *Getter* | get_multimesh() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | null | ++-----------+----------------------+ +| *Setter* | set_multimesh(value) | ++-----------+----------------------+ +| *Getter* | get_multimesh() | ++-----------+----------------------+ The :ref:`MultiMesh` resource that will be used and shared among all instances of the ``MultiMeshInstance``. diff --git a/classes/class_multimeshinstance2d.rst b/classes/class_multimeshinstance2d.rst index 11a23a40d..5303389b0 100644 --- a/classes/class_multimeshinstance2d.rst +++ b/classes/class_multimeshinstance2d.rst @@ -19,13 +19,13 @@ Node that instances a :ref:`MultiMesh` in 2D. Properties ---------- -+-----------------------------------+------------------------------------------------------------------+ -| :ref:`MultiMesh` | :ref:`multimesh` | -+-----------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+-----------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-----------------------------------+------------------------------------------------------------------+ ++-----------------------------------+------------------------------------------------------------------+------+ +| :ref:`MultiMesh` | :ref:`multimesh` | null | ++-----------------------------------+------------------------------------------------------------------+------+ +| :ref:`Texture` | :ref:`normal_map` | null | ++-----------------------------------+------------------------------------------------------------------+------+ +| :ref:`Texture` | :ref:`texture` | null | ++-----------------------------------+------------------------------------------------------------------+------+ Signals ------- @@ -48,11 +48,13 @@ Property Descriptions - :ref:`MultiMesh` **multimesh** -+----------+----------------------+ -| *Setter* | set_multimesh(value) | -+----------+----------------------+ -| *Getter* | get_multimesh() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | null | ++-----------+----------------------+ +| *Setter* | set_multimesh(value) | ++-----------+----------------------+ +| *Getter* | get_multimesh() | ++-----------+----------------------+ The :ref:`MultiMesh` that will be drawn by the ``MultiMeshInstance2D``. @@ -60,11 +62,13 @@ The :ref:`MultiMesh` that will be drawn by the ``MultiMeshInsta - :ref:`Texture` **normal_map** -+----------+-----------------------+ -| *Setter* | set_normal_map(value) | -+----------+-----------------------+ -| *Getter* | get_normal_map() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++-----------+-----------------------+ +| *Getter* | get_normal_map() | ++-----------+-----------------------+ The normal map that will be used if using the default :ref:`CanvasItemMaterial`. @@ -72,11 +76,13 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ The :ref:`Texture` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 83b04385d..d23cfb7a9 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -19,13 +19,13 @@ High-level multiplayer API. Properties ---------- -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_object_decoding` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`refuse_new_network_connections` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`allow_object_decoding` | false | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+-------+ +| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`refuse_new_network_connections` | false | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+-------+ Methods ------- @@ -148,11 +148,13 @@ Property Descriptions - :ref:`bool` **allow_object_decoding** -+----------+----------------------------------+ -| *Setter* | set_allow_object_decoding(value) | -+----------+----------------------------------+ -| *Getter* | is_object_decoding_allowed() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_allow_object_decoding(value) | ++-----------+----------------------------------+ +| *Getter* | is_object_decoding_allowed() | ++-----------+----------------------------------+ If ``true`` (or if the :ref:`network_peer` has :ref:`PacketPeer.allow_object_decoding` set to ``true``), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. @@ -174,11 +176,13 @@ The peer object to handle the RPC system (effectively enabling networking when s - :ref:`bool` **refuse_new_network_connections** -+----------+-------------------------------------------+ -| *Setter* | set_refuse_new_network_connections(value) | -+----------+-------------------------------------------+ -| *Getter* | is_refusing_new_network_connections() | -+----------+-------------------------------------------+ ++-----------+-------------------------------------------+ +| *Default* | false | ++-----------+-------------------------------------------+ +| *Setter* | set_refuse_new_network_connections(value) | ++-----------+-------------------------------------------+ +| *Getter* | is_refusing_new_network_connections() | ++-----------+-------------------------------------------+ If ``true``, the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index f647b03b1..9f2f9aba9 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -19,15 +19,15 @@ Brief Description Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`class_name` | -+-----------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`GDNativeLibrary` | :ref:`library` | -+-----------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`script_class_icon_path` | -+-----------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`script_class_name` | -+-----------------------------------------------+-----------------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------+------+ +| :ref:`String` | :ref:`class_name` | "" | ++-----------------------------------------------+-----------------------------------------------------------------------------------+------+ +| :ref:`GDNativeLibrary` | :ref:`library` | null | ++-----------------------------------------------+-----------------------------------------------------------------------------------+------+ +| :ref:`String` | :ref:`script_class_icon_path` | "" | ++-----------------------------------------------+-----------------------------------------------------------------------------------+------+ +| :ref:`String` | :ref:`script_class_name` | "" | ++-----------------------------------------------+-----------------------------------------------------------------------------------+------+ Methods ------- @@ -51,41 +51,49 @@ Property Descriptions - :ref:`String` **class_name** -+----------+-----------------------+ -| *Setter* | set_class_name(value) | -+----------+-----------------------+ -| *Getter* | get_class_name() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | "" | ++-----------+-----------------------+ +| *Setter* | set_class_name(value) | ++-----------+-----------------------+ +| *Getter* | get_class_name() | ++-----------+-----------------------+ .. _class_NativeScript_property_library: - :ref:`GDNativeLibrary` **library** -+----------+--------------------+ -| *Setter* | set_library(value) | -+----------+--------------------+ -| *Getter* | get_library() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_library(value) | ++-----------+--------------------+ +| *Getter* | get_library() | ++-----------+--------------------+ .. _class_NativeScript_property_script_class_icon_path: - :ref:`String` **script_class_icon_path** -+----------+-----------------------------------+ -| *Setter* | set_script_class_icon_path(value) | -+----------+-----------------------------------+ -| *Getter* | get_script_class_icon_path() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | "" | ++-----------+-----------------------------------+ +| *Setter* | set_script_class_icon_path(value) | ++-----------+-----------------------------------+ +| *Getter* | get_script_class_icon_path() | ++-----------+-----------------------------------+ .. _class_NativeScript_property_script_class_name: - :ref:`String` **script_class_name** -+----------+------------------------------+ -| *Setter* | set_script_class_name(value) | -+----------+------------------------------+ -| *Getter* | get_script_class_name() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | "" | ++-----------+------------------------------+ +| *Setter* | set_script_class_name(value) | ++-----------+------------------------------+ +| *Getter* | get_script_class_name() | ++-----------+------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index c7732c6f3..f9d854f95 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -19,9 +19,9 @@ Mesh-based navigation and pathfinding node. Properties ---------- -+-------------------------------+-------------------------------------------------------+ -| :ref:`Vector3` | :ref:`up_vector` | -+-------------------------------+-------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`up_vector` | Vector3( 0, 1, 0 ) | ++-------------------------------+-------------------------------------------------------+--------------------+ Methods ------- @@ -56,11 +56,13 @@ Property Descriptions - :ref:`Vector3` **up_vector** -+----------+----------------------+ -| *Setter* | set_up_vector(value) | -+----------+----------------------+ -| *Getter* | get_up_vector() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Vector3( 0, 1, 0 ) | ++-----------+----------------------+ +| *Setter* | set_up_vector(value) | ++-----------+----------------------+ +| *Getter* | get_up_vector() | ++-----------+----------------------+ Defines which direction is up. By default, this is ``(0, 1, 0)``, which is the world's "up" direction. diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 7583c2f49..63088939f 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -19,45 +19,45 @@ Brief Description Properties ---------- -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`agent/height` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`agent/max_climb` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`agent/max_slope` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`agent/radius` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cell/height` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cell/size` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`detail/sample_distance` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`detail/sample_max_error` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`edge/max_error` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`edge/max_length` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`filter/filter_walkable_low_height_spans` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`filter/ledge_spans` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`filter/low_hanging_obstacles` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`geometry/collision_mask` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`geometry/parsed_geometry_type` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`polygon/verts_per_poly` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`region/merge_size` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`region/min_size` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`sample_partition_type/sample_partition_type` | -+---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`agent/height` | 2.0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`agent/max_climb` | 0.9 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`agent/max_slope` | 45.0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`agent/radius` | 0.6 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`cell/height` | 0.2 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`cell/size` | 0.3 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`detail/sample_distance` | 6.0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`detail/sample_max_error` | 1.0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`edge/max_error` | 1.3 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`edge/max_length` | 12.0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`filter/filter_walkable_low_height_spans` | false | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`filter/ledge_spans` | false | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`filter/low_hanging_obstacles` | false | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`geometry/collision_mask` | | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`geometry/parsed_geometry_type` | 0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`polygon/verts_per_poly` | 6.0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`region/merge_size` | 20.0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`region/min_size` | 8.0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`sample_partition_type/sample_partition_type` | 0 | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+-------+ Methods ------- @@ -116,131 +116,157 @@ Property Descriptions - :ref:`float` **agent/height** -+----------+-------------------------+ -| *Setter* | set_agent_height(value) | -+----------+-------------------------+ -| *Getter* | get_agent_height() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 2.0 | ++-----------+-------------------------+ +| *Setter* | set_agent_height(value) | ++-----------+-------------------------+ +| *Getter* | get_agent_height() | ++-----------+-------------------------+ .. _class_NavigationMesh_property_agent/max_climb: - :ref:`float` **agent/max_climb** -+----------+----------------------------+ -| *Setter* | set_agent_max_climb(value) | -+----------+----------------------------+ -| *Getter* | get_agent_max_climb() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0.9 | ++-----------+----------------------------+ +| *Setter* | set_agent_max_climb(value) | ++-----------+----------------------------+ +| *Getter* | get_agent_max_climb() | ++-----------+----------------------------+ .. _class_NavigationMesh_property_agent/max_slope: - :ref:`float` **agent/max_slope** -+----------+----------------------------+ -| *Setter* | set_agent_max_slope(value) | -+----------+----------------------------+ -| *Getter* | get_agent_max_slope() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 45.0 | ++-----------+----------------------------+ +| *Setter* | set_agent_max_slope(value) | ++-----------+----------------------------+ +| *Getter* | get_agent_max_slope() | ++-----------+----------------------------+ .. _class_NavigationMesh_property_agent/radius: - :ref:`float` **agent/radius** -+----------+-------------------------+ -| *Setter* | set_agent_radius(value) | -+----------+-------------------------+ -| *Getter* | get_agent_radius() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0.6 | ++-----------+-------------------------+ +| *Setter* | set_agent_radius(value) | ++-----------+-------------------------+ +| *Getter* | get_agent_radius() | ++-----------+-------------------------+ .. _class_NavigationMesh_property_cell/height: - :ref:`float` **cell/height** -+----------+------------------------+ -| *Setter* | set_cell_height(value) | -+----------+------------------------+ -| *Getter* | get_cell_height() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.2 | ++-----------+------------------------+ +| *Setter* | set_cell_height(value) | ++-----------+------------------------+ +| *Getter* | get_cell_height() | ++-----------+------------------------+ .. _class_NavigationMesh_property_cell/size: - :ref:`float` **cell/size** -+----------+----------------------+ -| *Setter* | set_cell_size(value) | -+----------+----------------------+ -| *Getter* | get_cell_size() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0.3 | ++-----------+----------------------+ +| *Setter* | set_cell_size(value) | ++-----------+----------------------+ +| *Getter* | get_cell_size() | ++-----------+----------------------+ .. _class_NavigationMesh_property_detail/sample_distance: - :ref:`float` **detail/sample_distance** -+----------+-----------------------------------+ -| *Setter* | set_detail_sample_distance(value) | -+----------+-----------------------------------+ -| *Getter* | get_detail_sample_distance() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | 6.0 | ++-----------+-----------------------------------+ +| *Setter* | set_detail_sample_distance(value) | ++-----------+-----------------------------------+ +| *Getter* | get_detail_sample_distance() | ++-----------+-----------------------------------+ .. _class_NavigationMesh_property_detail/sample_max_error: - :ref:`float` **detail/sample_max_error** -+----------+------------------------------------+ -| *Setter* | set_detail_sample_max_error(value) | -+----------+------------------------------------+ -| *Getter* | get_detail_sample_max_error() | -+----------+------------------------------------+ ++-----------+------------------------------------+ +| *Default* | 1.0 | ++-----------+------------------------------------+ +| *Setter* | set_detail_sample_max_error(value) | ++-----------+------------------------------------+ +| *Getter* | get_detail_sample_max_error() | ++-----------+------------------------------------+ .. _class_NavigationMesh_property_edge/max_error: - :ref:`float` **edge/max_error** -+----------+---------------------------+ -| *Setter* | set_edge_max_error(value) | -+----------+---------------------------+ -| *Getter* | get_edge_max_error() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1.3 | ++-----------+---------------------------+ +| *Setter* | set_edge_max_error(value) | ++-----------+---------------------------+ +| *Getter* | get_edge_max_error() | ++-----------+---------------------------+ .. _class_NavigationMesh_property_edge/max_length: - :ref:`float` **edge/max_length** -+----------+----------------------------+ -| *Setter* | set_edge_max_length(value) | -+----------+----------------------------+ -| *Getter* | get_edge_max_length() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 12.0 | ++-----------+----------------------------+ +| *Setter* | set_edge_max_length(value) | ++-----------+----------------------------+ +| *Getter* | get_edge_max_length() | ++-----------+----------------------------+ .. _class_NavigationMesh_property_filter/filter_walkable_low_height_spans: - :ref:`bool` **filter/filter_walkable_low_height_spans** -+----------+---------------------------------------------+ -| *Setter* | set_filter_walkable_low_height_spans(value) | -+----------+---------------------------------------------+ -| *Getter* | get_filter_walkable_low_height_spans() | -+----------+---------------------------------------------+ ++-----------+---------------------------------------------+ +| *Default* | false | ++-----------+---------------------------------------------+ +| *Setter* | set_filter_walkable_low_height_spans(value) | ++-----------+---------------------------------------------+ +| *Getter* | get_filter_walkable_low_height_spans() | ++-----------+---------------------------------------------+ .. _class_NavigationMesh_property_filter/ledge_spans: - :ref:`bool` **filter/ledge_spans** -+----------+-------------------------------+ -| *Setter* | set_filter_ledge_spans(value) | -+----------+-------------------------------+ -| *Getter* | get_filter_ledge_spans() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | false | ++-----------+-------------------------------+ +| *Setter* | set_filter_ledge_spans(value) | ++-----------+-------------------------------+ +| *Getter* | get_filter_ledge_spans() | ++-----------+-------------------------------+ .. _class_NavigationMesh_property_filter/low_hanging_obstacles: - :ref:`bool` **filter/low_hanging_obstacles** -+----------+-----------------------------------------+ -| *Setter* | set_filter_low_hanging_obstacles(value) | -+----------+-----------------------------------------+ -| *Getter* | get_filter_low_hanging_obstacles() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | false | ++-----------+-----------------------------------------+ +| *Setter* | set_filter_low_hanging_obstacles(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_filter_low_hanging_obstacles() | ++-----------+-----------------------------------------+ .. _class_NavigationMesh_property_geometry/collision_mask: @@ -256,51 +282,61 @@ Property Descriptions - :ref:`int` **geometry/parsed_geometry_type** -+----------+---------------------------------+ -| *Setter* | set_parsed_geometry_type(value) | -+----------+---------------------------------+ -| *Getter* | get_parsed_geometry_type() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 0 | ++-----------+---------------------------------+ +| *Setter* | set_parsed_geometry_type(value) | ++-----------+---------------------------------+ +| *Getter* | get_parsed_geometry_type() | ++-----------+---------------------------------+ .. _class_NavigationMesh_property_polygon/verts_per_poly: - :ref:`float` **polygon/verts_per_poly** -+----------+---------------------------+ -| *Setter* | set_verts_per_poly(value) | -+----------+---------------------------+ -| *Getter* | get_verts_per_poly() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 6.0 | ++-----------+---------------------------+ +| *Setter* | set_verts_per_poly(value) | ++-----------+---------------------------+ +| *Getter* | get_verts_per_poly() | ++-----------+---------------------------+ .. _class_NavigationMesh_property_region/merge_size: - :ref:`float` **region/merge_size** -+----------+------------------------------+ -| *Setter* | set_region_merge_size(value) | -+----------+------------------------------+ -| *Getter* | get_region_merge_size() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | 20.0 | ++-----------+------------------------------+ +| *Setter* | set_region_merge_size(value) | ++-----------+------------------------------+ +| *Getter* | get_region_merge_size() | ++-----------+------------------------------+ .. _class_NavigationMesh_property_region/min_size: - :ref:`float` **region/min_size** -+----------+----------------------------+ -| *Setter* | set_region_min_size(value) | -+----------+----------------------------+ -| *Getter* | get_region_min_size() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 8.0 | ++-----------+----------------------------+ +| *Setter* | set_region_min_size(value) | ++-----------+----------------------------+ +| *Getter* | get_region_min_size() | ++-----------+----------------------------+ .. _class_NavigationMesh_property_sample_partition_type/sample_partition_type: - :ref:`int` **sample_partition_type/sample_partition_type** -+----------+----------------------------------+ -| *Setter* | set_sample_partition_type(value) | -+----------+----------------------------------+ -| *Getter* | get_sample_partition_type() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 0 | ++-----------+----------------------------------+ +| *Setter* | set_sample_partition_type(value) | ++-----------+----------------------------------+ +| *Getter* | get_sample_partition_type() | ++-----------+----------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 128f8e41b..74ba86717 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+---------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+---------------------------------------------+---------------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`navmesh` | -+---------------------------------------------+---------------------------------------------------------------+ ++---------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`enabled` | true | ++---------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`NavigationMesh` | :ref:`navmesh` | null | ++---------------------------------------------+---------------------------------------------------------------+------+ Property Descriptions --------------------- @@ -32,19 +32,23 @@ Property Descriptions - :ref:`bool` **enabled** -+----------+--------------------+ -| *Setter* | set_enabled(value) | -+----------+--------------------+ -| *Getter* | is_enabled() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | true | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ .. _class_NavigationMeshInstance_property_navmesh: - :ref:`NavigationMesh` **navmesh** -+----------+----------------------------+ -| *Setter* | set_navigation_mesh(value) | -+----------+----------------------------+ -| *Getter* | get_navigation_mesh() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | null | ++-----------+----------------------------+ +| *Setter* | set_navigation_mesh(value) | ++-----------+----------------------------+ +| *Getter* | get_navigation_mesh() | ++-----------+----------------------------+ diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index e48e03cb5..589d1de27 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+---------------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+---------------------------------------------------+------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`navpoly` | -+---------------------------------------------------+------------------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`enabled` | true | ++---------------------------------------------------+------------------------------------------------------------------+------+ +| :ref:`NavigationPolygon` | :ref:`navpoly` | null | ++---------------------------------------------------+------------------------------------------------------------------+------+ Property Descriptions --------------------- @@ -32,19 +32,23 @@ Property Descriptions - :ref:`bool` **enabled** -+----------+--------------------+ -| *Setter* | set_enabled(value) | -+----------+--------------------+ -| *Getter* | is_enabled() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | true | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ .. _class_NavigationPolygonInstance_property_navpoly: - :ref:`NavigationPolygon` **navpoly** -+----------+-------------------------------+ -| *Setter* | set_navigation_polygon(value) | -+----------+-------------------------------+ -| *Getter* | get_navigation_polygon() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | null | ++-----------+-------------------------------+ +| *Setter* | set_navigation_polygon(value) | ++-----------+-------------------------------+ +| *Getter* | get_navigation_polygon() | ++-----------+-------------------------------+ diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index b34072b63..3c928bdfe 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -19,15 +19,15 @@ PacketPeer implementation using the `ENet `_ Properties ---------- -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`always_ordered` | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`channel_count` | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`CompressionMode` | :ref:`compression_mode` | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transfer_channel` | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`always_ordered` | false | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`channel_count` | 3 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ +| :ref:`CompressionMode` | :ref:`compression_mode` | 0 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`transfer_channel` | -1 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+-------+ Methods ------- @@ -98,11 +98,13 @@ Property Descriptions - :ref:`bool` **always_ordered** -+----------+---------------------------+ -| *Setter* | set_always_ordered(value) | -+----------+---------------------------+ -| *Getter* | is_always_ordered() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_always_ordered(value) | ++-----------+---------------------------+ +| *Getter* | is_always_ordered() | ++-----------+---------------------------+ Enforce ordered packets when using :ref:`NetworkedMultiplayerPeer.TRANSFER_MODE_UNRELIABLE` (thus behaving similarly to :ref:`NetworkedMultiplayerPeer.TRANSFER_MODE_UNRELIABLE_ORDERED`). This is the only way to use ordering with the RPC system. @@ -110,35 +112,41 @@ Enforce ordered packets when using :ref:`NetworkedMultiplayerPeer.TRANSFER_MODE_ - :ref:`int` **channel_count** -+----------+--------------------------+ -| *Setter* | set_channel_count(value) | -+----------+--------------------------+ -| *Getter* | get_channel_count() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 3 | ++-----------+--------------------------+ +| *Setter* | set_channel_count(value) | ++-----------+--------------------------+ +| *Getter* | get_channel_count() | ++-----------+--------------------------+ -The number of channels to be used by ENet. Default: ``3``. Channels are used to separate different kinds of data. In reliable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. +The number of channels to be used by ENet. Channels are used to separate different kinds of data. In reliable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. .. _class_NetworkedMultiplayerENet_property_compression_mode: - :ref:`CompressionMode` **compression_mode** -+----------+-----------------------------+ -| *Setter* | set_compression_mode(value) | -+----------+-----------------------------+ -| *Getter* | get_compression_mode() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0 | ++-----------+-----------------------------+ +| *Setter* | set_compression_mode(value) | ++-----------+-----------------------------+ +| *Getter* | get_compression_mode() | ++-----------+-----------------------------+ -The compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. Default value: :ref:`COMPRESS_NONE`. +The compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. .. _class_NetworkedMultiplayerENet_property_transfer_channel: - :ref:`int` **transfer_channel** -+----------+-----------------------------+ -| *Setter* | set_transfer_channel(value) | -+----------+-----------------------------+ -| *Getter* | get_transfer_channel() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | -1 | ++-----------+-----------------------------+ +| *Setter* | set_transfer_channel(value) | ++-----------+-----------------------------+ +| *Getter* | get_transfer_channel() | ++-----------+-----------------------------+ Set the default channel to be used to transfer data. By default, this value is ``-1`` which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel ``0`` is reserved, and cannot be used. Setting this member to any value between ``0`` and :ref:`channel_count` (excluded) will force ENet to use that channel for sending data. diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 47479efcf..d329148d0 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -21,11 +21,11 @@ A high-level network interface to simplify multiplayer interactions. Properties ---------- -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`refuse_new_connections` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`TransferMode` | :ref:`transfer_mode` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`refuse_new_connections` | true | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+------+ +| :ref:`TransferMode` | :ref:`transfer_mode` | 0 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+------+ Methods ------- @@ -138,23 +138,27 @@ Property Descriptions - :ref:`bool` **refuse_new_connections** -+----------+-----------------------------------+ -| *Setter* | set_refuse_new_connections(value) | -+----------+-----------------------------------+ -| *Getter* | is_refusing_new_connections() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | true | ++-----------+-----------------------------------+ +| *Setter* | set_refuse_new_connections(value) | ++-----------+-----------------------------------+ +| *Getter* | is_refusing_new_connections() | ++-----------+-----------------------------------+ -If ``true``, this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. +If ``true``, this ``NetworkedMultiplayerPeer`` refuses new connections. .. _class_NetworkedMultiplayerPeer_property_transfer_mode: - :ref:`TransferMode` **transfer_mode** -+----------+--------------------------+ -| *Setter* | set_transfer_mode(value) | -+----------+--------------------------+ -| *Getter* | get_transfer_mode() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_transfer_mode(value) | ++-----------+--------------------------+ +| *Getter* | get_transfer_mode() | ++-----------+--------------------------+ The manner in which to send packets to the ``target_peer``. See :ref:`TransferMode`. @@ -191,5 +195,5 @@ Waits up to 1 second to receive a new network event. Sets the peer to which packets will be sent. -The ``id`` can be one of: :ref:`TARGET_PEER_BROADCAST` to send to all connected peers, :ref:`TARGET_PEER_SERVER` to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. Default: :ref:`TARGET_PEER_BROADCAST` +The ``id`` can be one of: :ref:`TARGET_PEER_BROADCAST` to send to all connected peers, :ref:`TARGET_PEER_SERVER` to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is :ref:`TARGET_PEER_BROADCAST`. diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 5f8e9bf71..ed52b0673 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -19,25 +19,25 @@ Scalable texture-based frame that tiles the texture's centers and sides, but kee Properties ---------- -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_center` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`patch_margin_bottom` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`patch_margin_left` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`patch_margin_right` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`patch_margin_top` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+------------------------------------------------------------+--------------------------------------------------------------------------------------+ ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | 0 | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | 0 | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`draw_center` | true | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`patch_margin_bottom` | 0 | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`patch_margin_left` | 0 | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`patch_margin_right` | 0 | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`patch_margin_top` | 0 | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`Rect2` | :ref:`region_rect` | Rect2( 0, 0, 0, 0 ) | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+---------------------+ Signals ------- @@ -61,7 +61,7 @@ Enumerations enum **AxisStretchMode**: -- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing. Default value for ``axis_stretch_horizontal`` and ``axis_stretch_vertical``. +- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing. - **AXIS_STRETCH_MODE_TILE** = **1** --- Doesn't do anything at the time of writing. @@ -79,11 +79,13 @@ Property Descriptions - :ref:`AxisStretchMode` **axis_stretch_horizontal** -+----------+--------------------------------+ -| *Setter* | set_h_axis_stretch_mode(value) | -+----------+--------------------------------+ -| *Getter* | get_h_axis_stretch_mode() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0 | ++-----------+--------------------------------+ +| *Setter* | set_h_axis_stretch_mode(value) | ++-----------+--------------------------------+ +| *Getter* | get_h_axis_stretch_mode() | ++-----------+--------------------------------+ Doesn't do anything at the time of writing. @@ -91,11 +93,13 @@ Doesn't do anything at the time of writing. - :ref:`AxisStretchMode` **axis_stretch_vertical** -+----------+--------------------------------+ -| *Setter* | set_v_axis_stretch_mode(value) | -+----------+--------------------------------+ -| *Getter* | get_v_axis_stretch_mode() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0 | ++-----------+--------------------------------+ +| *Setter* | set_v_axis_stretch_mode(value) | ++-----------+--------------------------------+ +| *Getter* | get_v_axis_stretch_mode() | ++-----------+--------------------------------+ Doesn't do anything at the time of writing. @@ -103,23 +107,27 @@ Doesn't do anything at the time of writing. - :ref:`bool` **draw_center** -+----------+--------------------------+ -| *Setter* | set_draw_center(value) | -+----------+--------------------------+ -| *Getter* | is_draw_center_enabled() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | true | ++-----------+--------------------------+ +| *Setter* | set_draw_center(value) | ++-----------+--------------------------+ +| *Getter* | is_draw_center_enabled() | ++-----------+--------------------------+ -If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Default value: ``true``. +If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. .. _class_NinePatchRect_property_patch_margin_bottom: - :ref:`int` **patch_margin_bottom** -+----------+-------------------------+ -| *Setter* | set_patch_margin(value) | -+----------+-------------------------+ -| *Getter* | get_patch_margin() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_patch_margin(value) | ++-----------+-------------------------+ +| *Getter* | get_patch_margin() | ++-----------+-------------------------+ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. @@ -127,11 +135,13 @@ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's botto - :ref:`int` **patch_margin_left** -+----------+-------------------------+ -| *Setter* | set_patch_margin(value) | -+----------+-------------------------+ -| *Getter* | get_patch_margin() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_patch_margin(value) | ++-----------+-------------------------+ +| *Getter* | get_patch_margin() | ++-----------+-------------------------+ The height of the 9-slice's left column. @@ -139,11 +149,13 @@ The height of the 9-slice's left column. - :ref:`int` **patch_margin_right** -+----------+-------------------------+ -| *Setter* | set_patch_margin(value) | -+----------+-------------------------+ -| *Getter* | get_patch_margin() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_patch_margin(value) | ++-----------+-------------------------+ +| *Getter* | get_patch_margin() | ++-----------+-------------------------+ The height of the 9-slice's right column. @@ -151,11 +163,13 @@ The height of the 9-slice's right column. - :ref:`int` **patch_margin_top** -+----------+-------------------------+ -| *Setter* | set_patch_margin(value) | -+----------+-------------------------+ -| *Getter* | get_patch_margin() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_patch_margin(value) | ++-----------+-------------------------+ +| *Getter* | get_patch_margin() | ++-----------+-------------------------+ The height of the 9-slice's top row. @@ -163,11 +177,13 @@ The height of the 9-slice's top row. - :ref:`Rect2` **region_rect** -+----------+------------------------+ -| *Setter* | set_region_rect(value) | -+----------+------------------------+ -| *Getter* | get_region_rect() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Rect2( 0, 0, 0, 0 ) | ++-----------+------------------------+ +| *Setter* | set_region_rect(value) | ++-----------+------------------------+ +| *Getter* | get_region_rect() | ++-----------+------------------------+ Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. @@ -175,11 +191,13 @@ Rectangular region of the texture to sample from. If you're working with an atla - :ref:`Texture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ The node's texture resource. diff --git a/classes/class_node.rst b/classes/class_node.rst index 95f572ec4..ad7b2793d 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -21,19 +21,19 @@ Base class for all *scene* objects. Properties ---------- -+---------------------------------------------+-------------------------------------------------------------------+ -| :ref:`MultiplayerAPI` | :ref:`custom_multiplayer` | -+---------------------------------------------+-------------------------------------------------------------------+ -| :ref:`String` | :ref:`filename` | -+---------------------------------------------+-------------------------------------------------------------------+ -| :ref:`MultiplayerAPI` | :ref:`multiplayer` | -+---------------------------------------------+-------------------------------------------------------------------+ -| :ref:`String` | :ref:`name` | -+---------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Node` | :ref:`owner` | -+---------------------------------------------+-------------------------------------------------------------------+ -| :ref:`PauseMode` | :ref:`pause_mode` | -+---------------------------------------------+-------------------------------------------------------------------+ ++---------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`MultiplayerAPI` | :ref:`custom_multiplayer` | | ++---------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`String` | :ref:`filename` | | ++---------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`MultiplayerAPI` | :ref:`multiplayer` | | ++---------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`String` | :ref:`name` | | ++---------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`Node` | :ref:`owner` | | ++---------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`PauseMode` | :ref:`pause_mode` | 0 | ++---------------------------------------------+-------------------------------------------------------------------+---+ Methods ------- @@ -512,11 +512,13 @@ The node owner. A node can have any other node as owner (as long as it is a vali - :ref:`PauseMode` **pause_mode** -+----------+-----------------------+ -| *Setter* | set_pause_mode(value) | -+----------+-----------------------+ -| *Getter* | get_pause_mode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_pause_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_pause_mode() | ++-----------+-----------------------+ Pause mode. How the node will behave if the :ref:`SceneTree` is paused. diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 8e5e49aa3..34e94ee65 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -21,31 +21,31 @@ A 2D game object, parent of all 2D-related nodes. Has a position, rotation, scal Properties ---------- -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`global_position` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`global_rotation` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`global_rotation_degrees` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`global_scale` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`global_transform` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation_degrees` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scale` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`z_as_relative` | -+---------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`z_index` | -+---------------------------------------+-------------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`global_position` | | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`global_rotation` | | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`global_rotation_degrees` | | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`global_scale` | | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`Transform2D` | :ref:`global_transform` | | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`position` | Vector2( 0, 0 ) | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`rotation` | 0.0 | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`rotation_degrees` | 0.0 | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`scale` | Vector2( 1, 1 ) | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`Transform2D` | :ref:`transform` | | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`z_as_relative` | true | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`z_index` | 0 | ++---------------------------------------+-------------------------------------------------------------------------------+-----------------+ Methods ------- @@ -151,11 +151,13 @@ Global :ref:`Transform2D`. - :ref:`Vector2` **position** -+----------+---------------------+ -| *Setter* | set_position(value) | -+----------+---------------------+ -| *Getter* | get_position() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_position(value) | ++-----------+---------------------+ +| *Getter* | get_position() | ++-----------+---------------------+ Position, relative to the node's parent. @@ -163,11 +165,13 @@ Position, relative to the node's parent. - :ref:`float` **rotation** -+----------+---------------------+ -| *Setter* | set_rotation(value) | -+----------+---------------------+ -| *Getter* | get_rotation() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_rotation(value) | ++-----------+---------------------+ +| *Getter* | get_rotation() | ++-----------+---------------------+ Rotation in radians, relative to the node's parent. @@ -175,11 +179,13 @@ Rotation in radians, relative to the node's parent. - :ref:`float` **rotation_degrees** -+----------+-----------------------------+ -| *Setter* | set_rotation_degrees(value) | -+----------+-----------------------------+ -| *Getter* | get_rotation_degrees() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_rotation_degrees(value) | ++-----------+-----------------------------+ +| *Getter* | get_rotation_degrees() | ++-----------+-----------------------------+ Rotation in degrees, relative to the node's parent. @@ -187,11 +193,13 @@ Rotation in degrees, relative to the node's parent. - :ref:`Vector2` **scale** -+----------+------------------+ -| *Setter* | set_scale(value) | -+----------+------------------+ -| *Getter* | get_scale() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | Vector2( 1, 1 ) | ++-----------+------------------+ +| *Setter* | set_scale(value) | ++-----------+------------------+ +| *Getter* | get_scale() | ++-----------+------------------+ The node's scale. Unscaled value: ``(1, 1)``. @@ -211,11 +219,13 @@ Local :ref:`Transform2D`. - :ref:`bool` **z_as_relative** -+----------+--------------------------+ -| *Setter* | set_z_as_relative(value) | -+----------+--------------------------+ -| *Getter* | is_z_relative() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | true | ++-----------+--------------------------+ +| *Setter* | set_z_as_relative(value) | ++-----------+--------------------------+ +| *Getter* | is_z_relative() | ++-----------+--------------------------+ If ``true``, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5. @@ -223,11 +233,13 @@ If ``true``, the node's Z index is relative to its parent's Z index. If this nod - :ref:`int` **z_index** -+----------+--------------------+ -| *Setter* | set_z_index(value) | -+----------+--------------------+ -| *Getter* | get_z_index() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 0 | ++-----------+--------------------+ +| *Setter* | set_z_index(value) | ++-----------+--------------------+ +| *Getter* | get_z_index() | ++-----------+--------------------+ Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index fbb46ad50..d6c517b89 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -19,19 +19,19 @@ Brief Description Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`as_normalmap` | -+-------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`bump_strength` | -+-------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`height` | -+-------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`OpenSimplexNoise` | :ref:`noise` | -+-------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`seamless` | -+-------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`width` | -+-------------------------------------------------+-----------------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`as_normalmap` | false | ++-------------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`bump_strength` | 8.0 | ++-------------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`height` | 512 | ++-------------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`OpenSimplexNoise` | :ref:`noise` | null | ++-------------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`seamless` | false | ++-------------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`width` | 512 | ++-------------------------------------------------+-----------------------------------------------------------------+-------+ Description ----------- @@ -47,11 +47,13 @@ Property Descriptions - :ref:`bool` **as_normalmap** -+----------+-------------------------+ -| *Setter* | set_as_normalmap(value) | -+----------+-------------------------+ -| *Getter* | is_normalmap() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_as_normalmap(value) | ++-----------+-------------------------+ +| *Getter* | is_normalmap() | ++-----------+-------------------------+ If ``true``, the resulting texture contains a normal map created from the original noise interpreted as a bump map. @@ -59,21 +61,25 @@ If ``true``, the resulting texture contains a normal map created from the origin - :ref:`float` **bump_strength** -+----------+--------------------------+ -| *Setter* | set_bump_strength(value) | -+----------+--------------------------+ -| *Getter* | get_bump_strength() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 8.0 | ++-----------+--------------------------+ +| *Setter* | set_bump_strength(value) | ++-----------+--------------------------+ +| *Getter* | get_bump_strength() | ++-----------+--------------------------+ .. _class_NoiseTexture_property_height: - :ref:`int` **height** -+----------+-------------------+ -| *Setter* | set_height(value) | -+----------+-------------------+ -| *Getter* | get_height() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 512 | ++-----------+-------------------+ +| *Setter* | set_height(value) | ++-----------+-------------------+ +| *Getter* | get_height() | ++-----------+-------------------+ Height of the generated texture. @@ -81,11 +87,13 @@ Height of the generated texture. - :ref:`OpenSimplexNoise` **noise** -+----------+------------------+ -| *Setter* | set_noise(value) | -+----------+------------------+ -| *Getter* | get_noise() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | null | ++-----------+------------------+ +| *Setter* | set_noise(value) | ++-----------+------------------+ +| *Getter* | get_noise() | ++-----------+------------------+ The :ref:`OpenSimplexNoise` instance used to generate the noise. @@ -93,11 +101,13 @@ The :ref:`OpenSimplexNoise` instance used to generate th - :ref:`bool` **seamless** -+----------+---------------------+ -| *Setter* | set_seamless(value) | -+----------+---------------------+ -| *Getter* | get_seamless() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_seamless(value) | ++-----------+---------------------+ +| *Getter* | get_seamless() | ++-----------+---------------------+ Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate. @@ -105,11 +115,13 @@ Whether the texture can be tiled without visible seams or not. Seamless textures - :ref:`int` **width** -+----------+------------------+ -| *Setter* | set_width(value) | -+----------+------------------+ -| *Getter* | get_width() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 512 | ++-----------+------------------+ +| *Setter* | set_width(value) | ++-----------+------------------+ +| *Getter* | get_width() | ++-----------+------------------+ Width of the generated texture. diff --git a/classes/class_object.rst b/classes/class_object.rst index c594d7f68..7c09f6ef8 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -218,7 +218,7 @@ Sets a property. Returns ``true`` if the ``property`` exists. Virtual method which can be overridden to customize the return value of :ref:`to_string`, and thus the object's representation where it is converted to a string, e.g. with ``print(obj)``. -Returns a :ref:`String` representing the object. Default is ``"[ClassName:RID]"``. +Returns a :ref:`String` representing the object. If not overridden, defaults to ``"[ClassName:RID]"``. .. _class_Object_method_add_user_signal: @@ -485,7 +485,7 @@ Assigns a new value to the property identified by the :ref:`NodePath` enable **)** -Defines whether the object can translate strings (with calls to :ref:`tr`). Default is ``true``. +Defines whether the object can translate strings (with calls to :ref:`tr`). Enabled by default. .. _class_Object_method_set_meta: @@ -503,7 +503,7 @@ Assigns a script to the object. Each object can have a single script assigned to - :ref:`String` **to_string** **(** **)** -Returns a :ref:`String` representing the object. Default is ``"[ClassName:RID]"``. +Returns a :ref:`String` representing the object. If not overridden, defaults to ``"[ClassName:RID]"``. Override the method :ref:`_to_string` to customize the :ref:`String` representation. diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index d35a2c0bc..833b4a550 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -19,13 +19,13 @@ Defines a 2D polygon for LightOccluder2D. Properties ---------- -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`closed` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`CullMode` | :ref:`cull_mode` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+--------------------------------------------------+--------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`closed` | true | ++--------------------------------------------------+--------------------------------------------------------------+----------------------+ +| :ref:`CullMode` | :ref:`cull_mode` | 0 | ++--------------------------------------------------+--------------------------------------------------------------+----------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | PoolVector2Array( ) | ++--------------------------------------------------+--------------------------------------------------------------+----------------------+ Enumerations ------------ @@ -58,35 +58,41 @@ Property Descriptions - :ref:`bool` **closed** -+----------+-------------------+ -| *Setter* | set_closed(value) | -+----------+-------------------+ -| *Getter* | is_closed() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_closed(value) | ++-----------+-------------------+ +| *Getter* | is_closed() | ++-----------+-------------------+ -If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value: ``true``. +If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. .. _class_OccluderPolygon2D_property_cull_mode: - :ref:`CullMode` **cull_mode** -+----------+----------------------+ -| *Setter* | set_cull_mode(value) | -+----------+----------------------+ -| *Getter* | get_cull_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_cull_mode(value) | ++-----------+----------------------+ +| *Getter* | get_cull_mode() | ++-----------+----------------------+ -The culling mode to use. Default value: :ref:`CULL_DISABLED`. +The culling mode to use. .. _class_OccluderPolygon2D_property_polygon: - :ref:`PoolVector2Array` **polygon** -+----------+--------------------+ -| *Setter* | set_polygon(value) | -+----------+--------------------+ -| *Getter* | get_polygon() | -+----------+--------------------+ ++-----------+----------------------+ +| *Default* | PoolVector2Array( ) | ++-----------+----------------------+ +| *Setter* | set_polygon(value) | ++-----------+----------------------+ +| *Getter* | get_polygon() | ++-----------+----------------------+ A :ref:`Vector2` array with the index for polygon's vertices positions. diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 9894a121f..cd7fd9216 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -19,15 +19,15 @@ Omnidirectional light, such as a light bulb or a candle. Properties ---------- -+--------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`omni_attenuation` | -+--------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`omni_range` | -+--------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`ShadowDetail` | :ref:`omni_shadow_detail` | -+--------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`ShadowMode` | :ref:`omni_shadow_mode` | -+--------------------------------------------------+------------------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`omni_attenuation` | 1.0 | ++--------------------------------------------------+------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`omni_range` | 5.0 | ++--------------------------------------------------+------------------------------------------------------------------------+-----+ +| :ref:`ShadowDetail` | :ref:`omni_shadow_detail` | 1 | ++--------------------------------------------------+------------------------------------------------------------------------+-----+ +| :ref:`ShadowMode` | :ref:`omni_shadow_mode` | 1 | ++--------------------------------------------------+------------------------------------------------------------------------+-----+ Enumerations ------------ @@ -73,11 +73,13 @@ Property Descriptions - :ref:`float` **omni_attenuation** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The light's attenuation (drop-off) curve. A number of presets are available in the **Inspector** by right-clicking the curve. @@ -85,11 +87,13 @@ The light's attenuation (drop-off) curve. A number of presets are available in t - :ref:`float` **omni_range** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 5.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The light's radius. @@ -97,11 +101,13 @@ The light's radius. - :ref:`ShadowDetail` **omni_shadow_detail** -+----------+--------------------------+ -| *Setter* | set_shadow_detail(value) | -+----------+--------------------------+ -| *Getter* | get_shadow_detail() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1 | ++-----------+--------------------------+ +| *Setter* | set_shadow_detail(value) | ++-----------+--------------------------+ +| *Getter* | get_shadow_detail() | ++-----------+--------------------------+ See :ref:`ShadowDetail`. @@ -109,11 +115,13 @@ See :ref:`ShadowDetail`. - :ref:`ShadowMode` **omni_shadow_mode** -+----------+------------------------+ -| *Setter* | set_shadow_mode(value) | -+----------+------------------------+ -| *Getter* | get_shadow_mode() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1 | ++-----------+------------------------+ +| *Setter* | set_shadow_mode(value) | ++-----------+------------------------+ +| *Getter* | get_shadow_mode() | ++-----------+------------------------+ See :ref:`ShadowMode`. diff --git a/classes/class_opensimplexnoise.rst b/classes/class_opensimplexnoise.rst index 7c74e5909..079d32f09 100644 --- a/classes/class_opensimplexnoise.rst +++ b/classes/class_opensimplexnoise.rst @@ -19,17 +19,17 @@ Noise generator based on Open Simplex. Properties ---------- -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`lacunarity` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`octaves` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`period` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`persistence` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`seed` | -+---------------------------+-----------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------+------+ +| :ref:`float` | :ref:`lacunarity` | 2.0 | ++---------------------------+-----------------------------------------------------------------+------+ +| :ref:`int` | :ref:`octaves` | 3 | ++---------------------------+-----------------------------------------------------------------+------+ +| :ref:`float` | :ref:`period` | 64.0 | ++---------------------------+-----------------------------------------------------------------+------+ +| :ref:`float` | :ref:`persistence` | 0.5 | ++---------------------------+-----------------------------------------------------------------+------+ +| :ref:`int` | :ref:`seed` | 0 | ++---------------------------+-----------------------------------------------------------------+------+ Methods ------- @@ -80,11 +80,13 @@ Property Descriptions - :ref:`float` **lacunarity** -+----------+-----------------------+ -| *Setter* | set_lacunarity(value) | -+----------+-----------------------+ -| *Getter* | get_lacunarity() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 2.0 | ++-----------+-----------------------+ +| *Setter* | set_lacunarity(value) | ++-----------+-----------------------+ +| *Getter* | get_lacunarity() | ++-----------+-----------------------+ Difference in period between :ref:`octaves`. @@ -92,11 +94,13 @@ Difference in period between :ref:`octaves` **octaves** -+----------+--------------------+ -| *Setter* | set_octaves(value) | -+----------+--------------------+ -| *Getter* | get_octaves() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 3 | ++-----------+--------------------+ +| *Setter* | set_octaves(value) | ++-----------+--------------------+ +| *Getter* | get_octaves() | ++-----------+--------------------+ Number of OpenSimplex noise layers that are sampled to get the fractal noise. @@ -104,11 +108,13 @@ Number of OpenSimplex noise layers that are sampled to get the fractal noise. - :ref:`float` **period** -+----------+-------------------+ -| *Setter* | set_period(value) | -+----------+-------------------+ -| *Getter* | get_period() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 64.0 | ++-----------+-------------------+ +| *Setter* | set_period(value) | ++-----------+-------------------+ +| *Getter* | get_period() | ++-----------+-------------------+ Period of the base octave. A lower period results in a higher-frequency noise (more value changes across the same distance). @@ -116,11 +122,13 @@ Period of the base octave. A lower period results in a higher-frequency noise (m - :ref:`float` **persistence** -+----------+------------------------+ -| *Setter* | set_persistence(value) | -+----------+------------------------+ -| *Getter* | get_persistence() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.5 | ++-----------+------------------------+ +| *Setter* | set_persistence(value) | ++-----------+------------------------+ +| *Getter* | get_persistence() | ++-----------+------------------------+ Contribution factor of the different octaves. A ``persistence`` value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one. @@ -128,11 +136,13 @@ Contribution factor of the different octaves. A ``persistence`` value of 1 means - :ref:`int` **seed** -+----------+-----------------+ -| *Setter* | set_seed(value) | -+----------+-----------------+ -| *Getter* | get_seed() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_seed(value) | ++-----------+-----------------+ +| *Getter* | get_seed() | ++-----------+-----------------+ Seed used to generate random values, different seeds will generate different noise maps. diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index a66f9ec64..2bf315b66 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -19,9 +19,9 @@ Button control that provides selectable options when pressed. Properties ---------- -+-----------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`selected` | -+-----------------------+-------------------------------------------------------+ ++-----------------------+-------------------------------------------------------+----+ +| :ref:`int` | :ref:`selected` | -1 | ++-----------------------+-------------------------------------------------------+----+ Methods ------- @@ -73,33 +73,33 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`Texture` | arrow | -+---------------------------------+---------------------+ -| :ref:`int` | arrow_margin | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | disabled | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+---------------------+ -| :ref:`Font` | font | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_pressed | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | hover | -+---------------------------------+---------------------+ -| :ref:`int` | hseparation | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | pressed | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | arrow | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | arrow_margin | 2 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | disabled | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | hover | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | hseparation | 2 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | pressed | | ++---------------------------------+---------------------+------------------------------------------+ Signals ------- @@ -128,9 +128,11 @@ Property Descriptions - :ref:`int` **selected** -+----------+----------------+ -| *Getter* | get_selected() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | -1 | ++-----------+----------------+ +| *Getter* | get_selected() | ++-----------+----------------+ Method Descriptions ------------------- diff --git a/classes/class_os.rst b/classes/class_os.rst index 85b0f107b..bec737c55 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -19,41 +19,41 @@ Operating System functions. Properties ---------- -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`clipboard` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`current_screen` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`exit_code` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`keep_screen_on` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`low_processor_usage_mode` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`max_window_size` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`min_window_size` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`ScreenOrientation` | :ref:`screen_orientation` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`vsync_enabled` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_borderless` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_fullscreen` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_maximized` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_minimized` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_per_pixel_transparency_enabled` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`window_position` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_resizable` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`window_size` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`String` | :ref:`clipboard` | "" | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`current_screen` | 0 | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`exit_code` | 0 | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`keep_screen_on` | true | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`low_processor_usage_mode` | false | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`max_window_size` | Vector2( 0, 0 ) | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`min_window_size` | Vector2( 0, 0 ) | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`ScreenOrientation` | :ref:`screen_orientation` | 0 | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`vsync_enabled` | true | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`window_borderless` | false | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`window_fullscreen` | false | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`window_maximized` | false | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`window_minimized` | false | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`window_per_pixel_transparency_enabled` | false | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`window_position` | Vector2( 0, 0 ) | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`window_resizable` | true | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`window_size` | Vector2( 0, 0 ) | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+ Methods ------- @@ -447,11 +447,13 @@ Property Descriptions - :ref:`String` **clipboard** -+----------+----------------------+ -| *Setter* | set_clipboard(value) | -+----------+----------------------+ -| *Getter* | get_clipboard() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "" | ++-----------+----------------------+ +| *Setter* | set_clipboard(value) | ++-----------+----------------------+ +| *Getter* | get_clipboard() | ++-----------+----------------------+ The clipboard from the host OS. Might be unavailable on some platforms. @@ -459,11 +461,13 @@ The clipboard from the host OS. Might be unavailable on some platforms. - :ref:`int` **current_screen** -+----------+---------------------------+ -| *Setter* | set_current_screen(value) | -+----------+---------------------------+ -| *Getter* | get_current_screen() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_current_screen(value) | ++-----------+---------------------------+ +| *Getter* | get_current_screen() | ++-----------+---------------------------+ The current screen index (starting from 0). @@ -471,11 +475,13 @@ The current screen index (starting from 0). - :ref:`int` **exit_code** -+----------+----------------------+ -| *Setter* | set_exit_code(value) | -+----------+----------------------+ -| *Getter* | get_exit_code() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_exit_code(value) | ++-----------+----------------------+ +| *Getter* | get_exit_code() | ++-----------+----------------------+ The exit code passed to the OS when the main loop exits. @@ -483,11 +489,13 @@ The exit code passed to the OS when the main loop exits. - :ref:`bool` **keep_screen_on** -+----------+---------------------------+ -| *Setter* | set_keep_screen_on(value) | -+----------+---------------------------+ -| *Getter* | is_keep_screen_on() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | true | ++-----------+---------------------------+ +| *Setter* | set_keep_screen_on(value) | ++-----------+---------------------------+ +| *Getter* | is_keep_screen_on() | ++-----------+---------------------------+ If ``true``, the engine tries to keep the screen on while the game is running. Useful on mobile. @@ -495,11 +503,13 @@ If ``true``, the engine tries to keep the screen on while the game is running. U - :ref:`bool` **low_processor_usage_mode** -+----------+-------------------------------------+ -| *Setter* | set_low_processor_usage_mode(value) | -+----------+-------------------------------------+ -| *Getter* | is_in_low_processor_usage_mode() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | false | ++-----------+-------------------------------------+ +| *Setter* | set_low_processor_usage_mode(value) | ++-----------+-------------------------------------+ +| *Getter* | is_in_low_processor_usage_mode() | ++-----------+-------------------------------------+ If ``true``, the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. @@ -507,11 +517,13 @@ If ``true``, the engine optimizes for low processor usage by only refreshing the - :ref:`Vector2` **max_window_size** -+----------+----------------------------+ -| *Setter* | set_max_window_size(value) | -+----------+----------------------------+ -| *Getter* | get_max_window_size() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+----------------------------+ +| *Setter* | set_max_window_size(value) | ++-----------+----------------------------+ +| *Getter* | get_max_window_size() | ++-----------+----------------------------+ The maximum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to ``(0, 0)`` to reset to the system default value. @@ -519,11 +531,13 @@ The maximum size of the window (without counting window manager decorations). Do - :ref:`Vector2` **min_window_size** -+----------+----------------------------+ -| *Setter* | set_min_window_size(value) | -+----------+----------------------------+ -| *Getter* | get_min_window_size() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+----------------------------+ +| *Setter* | set_min_window_size(value) | ++-----------+----------------------------+ +| *Getter* | get_min_window_size() | ++-----------+----------------------------+ The minimum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to ``(0, 0)`` to reset to the system default value. @@ -531,11 +545,13 @@ The minimum size of the window (without counting window manager decorations). Do - :ref:`ScreenOrientation` **screen_orientation** -+----------+-------------------------------+ -| *Setter* | set_screen_orientation(value) | -+----------+-------------------------------+ -| *Getter* | get_screen_orientation() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0 | ++-----------+-------------------------------+ +| *Setter* | set_screen_orientation(value) | ++-----------+-------------------------------+ +| *Getter* | get_screen_orientation() | ++-----------+-------------------------------+ The current screen orientation. @@ -543,11 +559,13 @@ The current screen orientation. - :ref:`bool` **vsync_enabled** -+----------+----------------------+ -| *Setter* | set_use_vsync(value) | -+----------+----------------------+ -| *Getter* | is_vsync_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_use_vsync(value) | ++-----------+----------------------+ +| *Getter* | is_vsync_enabled() | ++-----------+----------------------+ If ``true``, vertical synchronization (Vsync) is enabled. @@ -555,11 +573,13 @@ If ``true``, vertical synchronization (Vsync) is enabled. - :ref:`bool` **window_borderless** -+----------+------------------------------+ -| *Setter* | set_borderless_window(value) | -+----------+------------------------------+ -| *Getter* | get_borderless_window() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_borderless_window(value) | ++-----------+------------------------------+ +| *Getter* | get_borderless_window() | ++-----------+------------------------------+ If ``true``, removes the window frame. @@ -569,11 +589,13 @@ If ``true``, removes the window frame. - :ref:`bool` **window_fullscreen** -+----------+------------------------------+ -| *Setter* | set_window_fullscreen(value) | -+----------+------------------------------+ -| *Getter* | is_window_fullscreen() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_window_fullscreen(value) | ++-----------+------------------------------+ +| *Getter* | is_window_fullscreen() | ++-----------+------------------------------+ If ``true``, the window is fullscreen. @@ -581,11 +603,13 @@ If ``true``, the window is fullscreen. - :ref:`bool` **window_maximized** -+----------+-----------------------------+ -| *Setter* | set_window_maximized(value) | -+----------+-----------------------------+ -| *Getter* | is_window_maximized() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | false | ++-----------+-----------------------------+ +| *Setter* | set_window_maximized(value) | ++-----------+-----------------------------+ +| *Getter* | is_window_maximized() | ++-----------+-----------------------------+ If ``true``, the window is maximized. @@ -593,11 +617,13 @@ If ``true``, the window is maximized. - :ref:`bool` **window_minimized** -+----------+-----------------------------+ -| *Setter* | set_window_minimized(value) | -+----------+-----------------------------+ -| *Getter* | is_window_minimized() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | false | ++-----------+-----------------------------+ +| *Setter* | set_window_minimized(value) | ++-----------+-----------------------------+ +| *Getter* | is_window_minimized() | ++-----------+-----------------------------+ If ``true``, the window is minimized. @@ -605,11 +631,13 @@ If ``true``, the window is minimized. - :ref:`bool` **window_per_pixel_transparency_enabled** -+----------+--------------------------------------------------+ -| *Setter* | set_window_per_pixel_transparency_enabled(value) | -+----------+--------------------------------------------------+ -| *Getter* | get_window_per_pixel_transparency_enabled() | -+----------+--------------------------------------------------+ ++-----------+--------------------------------------------------+ +| *Default* | false | ++-----------+--------------------------------------------------+ +| *Setter* | set_window_per_pixel_transparency_enabled(value) | ++-----------+--------------------------------------------------+ +| *Getter* | get_window_per_pixel_transparency_enabled() | ++-----------+--------------------------------------------------+ If ``true``, the window background is transparent and window frame is removed. @@ -621,11 +649,13 @@ Use ``get_tree().get_root().set_transparent_background(true)`` to disable main v - :ref:`Vector2` **window_position** -+----------+----------------------------+ -| *Setter* | set_window_position(value) | -+----------+----------------------------+ -| *Getter* | get_window_position() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+----------------------------+ +| *Setter* | set_window_position(value) | ++-----------+----------------------------+ +| *Getter* | get_window_position() | ++-----------+----------------------------+ The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. @@ -633,11 +663,13 @@ The window position relative to the screen, the origin is the top left corner, + - :ref:`bool` **window_resizable** -+----------+-----------------------------+ -| *Setter* | set_window_resizable(value) | -+----------+-----------------------------+ -| *Getter* | is_window_resizable() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | true | ++-----------+-----------------------------+ +| *Setter* | set_window_resizable(value) | ++-----------+-----------------------------+ +| *Getter* | is_window_resizable() | ++-----------+-----------------------------+ If ``true``, the window is resizable by the user. @@ -645,11 +677,13 @@ If ``true``, the window is resizable by the user. - :ref:`Vector2` **window_size** -+----------+------------------------+ -| *Setter* | set_window_size(value) | -+----------+------------------------+ -| *Getter* | get_window_size() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+------------------------+ +| *Setter* | set_window_size(value) | ++-----------+------------------------+ +| *Getter* | get_window_size() | ++-----------+------------------------+ The size of the window (without counting window manager decorations). @@ -944,6 +978,8 @@ Returns the dimensions in pixels of the specified screen. - :ref:`int` **get_splash_tick_msec** **(** **)** const +Returns the amount of time in milliseconds it took for the boot logo to appear. + .. _class_OS_method_get_static_memory_peak_usage: - :ref:`int` **get_static_memory_peak_usage** **(** **)** const @@ -1058,6 +1094,8 @@ Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyb - :ref:`Rect2` **get_window_safe_area** **(** **)** const +Returns unobscured area of the window where interactive controls should be rendered. + .. _class_OS_method_has_environment: - :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 36b1e3e5a..c370283c0 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`__data__` | -+-------------------------------------------+--------------------------------------------------------------+ ++-------------------------------------------+--------------------------------------------------------------+-------------------+ +| :ref:`PoolByteArray` | :ref:`__data__` | PoolByteArray( ) | ++-------------------------------------------+--------------------------------------------------------------+-------------------+ Methods ------- @@ -39,6 +39,10 @@ Property Descriptions - :ref:`PoolByteArray` **__data__** ++-----------+-------------------+ +| *Default* | PoolByteArray( ) | ++-----------+-------------------+ + Method Descriptions ------------------- diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index eda54c7ef..6c2d40ed1 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -19,9 +19,9 @@ An abstraction of a serialized scene. Properties ---------- -+-------------------------------------+------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`_bundled` | -+-------------------------------------+------------------------------------------------------+ ++-------------------------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`_bundled` | { "conn_count": 0, "conns": PoolIntArray( ), "editable_instances": [ ], "names": PoolStringArray( ), "node_count": 0, "node_paths": [ ], "nodes": PoolIntArray( ), "variants": [ ], "version": 2 } | ++-------------------------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Methods ------- @@ -97,6 +97,10 @@ Property Descriptions - :ref:`Dictionary` **_bundled** ++-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "conn_count": 0, "conns": PoolIntArray( ), "editable_instances": [ ], "names": PoolStringArray( ), "node_count": 0, "node_paths": [ ], "nodes": PoolIntArray( ), "variants": [ ], "version": 2 } | ++-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + A dictionary representation of the scene contents. Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 532199356..09768c52e 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -21,9 +21,9 @@ Abstraction and base class for packet-based protocols. Properties ---------- -+-------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_object_decoding` | -+-------------------------+-------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`allow_object_decoding` | false | ++-------------------------+-------------------------------------------------------------------------------+-------+ Methods ------- @@ -54,11 +54,13 @@ Property Descriptions - :ref:`bool` **allow_object_decoding** -+----------+----------------------------------+ -| *Setter* | set_allow_object_decoding(value) | -+----------+----------------------------------+ -| *Getter* | is_object_decoding_allowed() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_allow_object_decoding(value) | ++-----------+----------------------------------+ +| *Getter* | is_object_decoding_allowed() | ++-----------+----------------------------------+ *Deprecated.* Use ``get_var`` and ``put_var`` parameters instead. diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 44f394d0c..784981040 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -19,13 +19,13 @@ Wrapper to use a PacketPeer over a StreamPeer. Properties ---------- -+-------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`input_buffer_max_size` | -+-------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`output_buffer_max_size` | -+-------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`StreamPeer` | :ref:`stream_peer` | -+-------------------------------------+---------------------------------------------------------------------------------------+ ++-------------------------------------+---------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`input_buffer_max_size` | 65532 | ++-------------------------------------+---------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`output_buffer_max_size` | 65532 | ++-------------------------------------+---------------------------------------------------------------------------------------+-------+ +| :ref:`StreamPeer` | :ref:`stream_peer` | | ++-------------------------------------+---------------------------------------------------------------------------------------+-------+ Description ----------- @@ -39,21 +39,25 @@ Property Descriptions - :ref:`int` **input_buffer_max_size** -+----------+----------------------------------+ -| *Setter* | set_input_buffer_max_size(value) | -+----------+----------------------------------+ -| *Getter* | get_input_buffer_max_size() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 65532 | ++-----------+----------------------------------+ +| *Setter* | set_input_buffer_max_size(value) | ++-----------+----------------------------------+ +| *Getter* | get_input_buffer_max_size() | ++-----------+----------------------------------+ .. _class_PacketPeerStream_property_output_buffer_max_size: - :ref:`int` **output_buffer_max_size** -+----------+-----------------------------------+ -| *Setter* | set_output_buffer_max_size(value) | -+----------+-----------------------------------+ -| *Getter* | get_output_buffer_max_size() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | 65532 | ++-----------+-----------------------------------+ +| *Setter* | set_output_buffer_max_size(value) | ++-----------+-----------------------------------+ +| *Getter* | get_output_buffer_max_size() | ++-----------+-----------------------------------+ .. _class_PacketPeerStream_property_stream_peer: diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index c332f4413..e8537425d 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -19,9 +19,9 @@ A type of :ref:`Sky` used to draw a background texture. Properties ---------- -+-------------------------------+------------------------------------------------------+ -| :ref:`Texture` | :ref:`panorama` | -+-------------------------------+------------------------------------------------------+ ++-------------------------------+------------------------------------------------------+------+ +| :ref:`Texture` | :ref:`panorama` | null | ++-------------------------------+------------------------------------------------------+------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`Texture` **panorama** -+----------+---------------------+ -| *Setter* | set_panorama(value) | -+----------+---------------------+ -| *Getter* | get_panorama() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_panorama(value) | ++-----------+---------------------+ +| *Getter* | get_panorama() | ++-----------+---------------------+ :ref:`Texture` to be applied to the PanoramaSky. diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 7777b51eb..9993920e2 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -19,19 +19,19 @@ A node used to create a parallax scrolling background. Properties ---------- -+-------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_base_offset` | -+-------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_base_scale` | -+-------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_ignore_camera_zoom` | -+-------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_limit_begin` | -+-------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_limit_end` | -+-------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_offset` | -+-------------------------------+-----------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`scroll_base_offset` | Vector2( 0, 0 ) | ++-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`scroll_base_scale` | Vector2( 1, 1 ) | ++-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`scroll_ignore_camera_zoom` | false | ++-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`scroll_limit_begin` | Vector2( 0, 0 ) | ++-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`scroll_limit_end` | Vector2( 0, 0 ) | ++-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`scroll_offset` | Vector2( 0, 0 ) | ++-------------------------------+-----------------------------------------------------------------------------------------------+-----------------+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`Vector2` **scroll_base_offset** -+----------+-------------------------------+ -| *Setter* | set_scroll_base_offset(value) | -+----------+-------------------------------+ -| *Getter* | get_scroll_base_offset() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------------------+ +| *Setter* | set_scroll_base_offset(value) | ++-----------+-------------------------------+ +| *Getter* | get_scroll_base_offset() | ++-----------+-------------------------------+ The base position offset for all :ref:`ParallaxLayer` children. @@ -57,11 +59,13 @@ The base position offset for all :ref:`ParallaxLayer` child - :ref:`Vector2` **scroll_base_scale** -+----------+------------------------------+ -| *Setter* | set_scroll_base_scale(value) | -+----------+------------------------------+ -| *Getter* | get_scroll_base_scale() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | Vector2( 1, 1 ) | ++-----------+------------------------------+ +| *Setter* | set_scroll_base_scale(value) | ++-----------+------------------------------+ +| *Getter* | get_scroll_base_scale() | ++-----------+------------------------------+ The base motion scale for all :ref:`ParallaxLayer` children. @@ -69,11 +73,13 @@ The base motion scale for all :ref:`ParallaxLayer` children - :ref:`bool` **scroll_ignore_camera_zoom** -+----------+-------------------------------+ -| *Setter* | set_ignore_camera_zoom(value) | -+----------+-------------------------------+ -| *Getter* | is_ignore_camera_zoom() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | false | ++-----------+-------------------------------+ +| *Setter* | set_ignore_camera_zoom(value) | ++-----------+-------------------------------+ +| *Getter* | is_ignore_camera_zoom() | ++-----------+-------------------------------+ If ``true``, elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. @@ -81,11 +87,13 @@ If ``true``, elements in :ref:`ParallaxLayer` child aren't - :ref:`Vector2` **scroll_limit_begin** -+----------+------------------------+ -| *Setter* | set_limit_begin(value) | -+----------+------------------------+ -| *Getter* | get_limit_begin() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+------------------------+ +| *Setter* | set_limit_begin(value) | ++-----------+------------------------+ +| *Getter* | get_limit_begin() | ++-----------+------------------------+ Top-left limits for scrolling to begin. If the camera is outside of this limit, the background will stop scrolling. Must be lower than :ref:`scroll_limit_end` to work. @@ -93,11 +101,13 @@ Top-left limits for scrolling to begin. If the camera is outside of this limit, - :ref:`Vector2` **scroll_limit_end** -+----------+----------------------+ -| *Setter* | set_limit_end(value) | -+----------+----------------------+ -| *Getter* | get_limit_end() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+----------------------+ +| *Setter* | set_limit_end(value) | ++-----------+----------------------+ +| *Getter* | get_limit_end() | ++-----------+----------------------+ Bottom-right limits for scrolling to end. If the camera is outside of this limit, the background will stop scrolling. Must be higher than :ref:`scroll_limit_begin` to work. @@ -105,11 +115,13 @@ Bottom-right limits for scrolling to end. If the camera is outside of this limit - :ref:`Vector2` **scroll_offset** -+----------+--------------------------+ -| *Setter* | set_scroll_offset(value) | -+----------+--------------------------+ -| *Getter* | get_scroll_offset() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+--------------------------+ +| *Setter* | set_scroll_offset(value) | ++-----------+--------------------------+ +| *Getter* | get_scroll_offset() | ++-----------+--------------------------+ The ParallaxBackground's scroll value. Calculated automatically when using a :ref:`Camera2D`, but can be used to manually manage scrolling when no camera is present. diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 7f346c349..cd00f5b35 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -19,13 +19,13 @@ A parallax scrolling layer to be used with :ref:`ParallaxBackground` | :ref:`motion_mirroring` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion_offset` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion_scale` | -+-------------------------------+------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`motion_mirroring` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`motion_offset` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`motion_scale` | Vector2( 1, 1 ) | ++-------------------------------+------------------------------------------------------------------------+-----------------+ Description ----------- @@ -43,23 +43,27 @@ Property Descriptions - :ref:`Vector2` **motion_mirroring** -+----------+----------------------+ -| *Setter* | set_mirroring(value) | -+----------+----------------------+ -| *Getter* | get_mirroring() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+----------------------+ +| *Setter* | set_mirroring(value) | ++-----------+----------------------+ +| *Getter* | get_mirroring() | ++-----------+----------------------+ -The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0``, the :ref:`Texture` will not be mirrored. Default value: ``(0, 0)``. +The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0``, the :ref:`Texture` will not be mirrored. .. _class_ParallaxLayer_property_motion_offset: - :ref:`Vector2` **motion_offset** -+----------+--------------------------+ -| *Setter* | set_motion_offset(value) | -+----------+--------------------------+ -| *Getter* | get_motion_offset() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+--------------------------+ +| *Setter* | set_motion_offset(value) | ++-----------+--------------------------+ +| *Getter* | get_motion_offset() | ++-----------+--------------------------+ The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. @@ -67,11 +71,13 @@ The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`Par - :ref:`Vector2` **motion_scale** -+----------+-------------------------+ -| *Setter* | set_motion_scale(value) | -+----------+-------------------------+ -| *Getter* | get_motion_scale() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Vector2( 1, 1 ) | ++-----------+-------------------------+ +| *Setter* | set_motion_scale(value) | ++-----------+-------------------------+ +| *Getter* | get_motion_scale() | ++-----------+-------------------------+ Multiplies the ParallaxLayer's motion. If an axis is set to ``0``, it will not scroll. diff --git a/classes/class_particles.rst b/classes/class_particles.rst index a2eb485e4..989dbc484 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -19,45 +19,45 @@ Brief Description Properties ---------- -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`amount` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`draw_pass_1` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`draw_pass_2` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`draw_pass_3` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`draw_pass_4` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`draw_passes` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emitting` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`explosiveness` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_fps` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fract_delta` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`lifetime` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`local_coords` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`preprocess` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Material` | :ref:`process_material` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`randomness` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+--------------------------------------------+--------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`visibility_aabb` | -+--------------------------------------------+--------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`int` | :ref:`amount` | 8 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | 0 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`Mesh` | :ref:`draw_pass_1` | null | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`Mesh` | :ref:`draw_pass_2` | | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`Mesh` | :ref:`draw_pass_3` | | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`Mesh` | :ref:`draw_pass_4` | | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`int` | :ref:`draw_passes` | 1 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`bool` | :ref:`emitting` | true | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`explosiveness` | 0.0 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`int` | :ref:`fixed_fps` | 0 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`bool` | :ref:`fract_delta` | true | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`lifetime` | 1.0 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`bool` | :ref:`local_coords` | true | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`bool` | :ref:`one_shot` | false | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`preprocess` | 0.0 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`Material` | :ref:`process_material` | null | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`randomness` | 0.0 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`float` | :ref:`speed_scale` | 1.0 | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ +| :ref:`AABB` | :ref:`visibility_aabb` | AABB( -4, -4, -4, 8, 8, 8 ) | ++--------------------------------------------+--------------------------------------------------------------------+-----------------------------+ Methods ------- @@ -113,11 +113,13 @@ Property Descriptions - :ref:`int` **amount** -+----------+-------------------+ -| *Setter* | set_amount(value) | -+----------+-------------------+ -| *Getter* | get_amount() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 8 | ++-----------+-------------------+ +| *Setter* | set_amount(value) | ++-----------+-------------------+ +| *Getter* | get_amount() | ++-----------+-------------------+ Number of particles to emit. @@ -125,23 +127,27 @@ Number of particles to emit. - :ref:`DrawOrder` **draw_order** -+----------+-----------------------+ -| *Setter* | set_draw_order(value) | -+----------+-----------------------+ -| *Getter* | get_draw_order() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_draw_order(value) | ++-----------+-----------------------+ +| *Getter* | get_draw_order() | ++-----------+-----------------------+ -Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORDER_INDEX`. +Particle draw order. Uses ``DRAW_ORDER_*`` values. .. _class_Particles_property_draw_pass_1: - :ref:`Mesh` **draw_pass_1** -+----------+---------------------------+ -| *Setter* | set_draw_pass_mesh(value) | -+----------+---------------------------+ -| *Getter* | get_draw_pass_mesh() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | null | ++-----------+---------------------------+ +| *Setter* | set_draw_pass_mesh(value) | ++-----------+---------------------------+ +| *Getter* | get_draw_pass_mesh() | ++-----------+---------------------------+ :ref:`Mesh` that is drawn for the first draw pass. @@ -185,11 +191,13 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORD - :ref:`int` **draw_passes** -+----------+------------------------+ -| *Setter* | set_draw_passes(value) | -+----------+------------------------+ -| *Getter* | get_draw_passes() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1 | ++-----------+------------------------+ +| *Setter* | set_draw_passes(value) | ++-----------+------------------------+ +| *Getter* | get_draw_passes() | ++-----------+------------------------+ The number of draw passes when rendering particles. @@ -197,35 +205,41 @@ The number of draw passes when rendering particles. - :ref:`bool` **emitting** -+----------+---------------------+ -| *Setter* | set_emitting(value) | -+----------+---------------------+ -| *Getter* | is_emitting() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_emitting(value) | ++-----------+---------------------+ +| *Getter* | is_emitting() | ++-----------+---------------------+ -If ``true``, particles are being emitted. Default value: ``true``. +If ``true``, particles are being emitted. .. _class_Particles_property_explosiveness: - :ref:`float` **explosiveness** -+----------+--------------------------------+ -| *Setter* | set_explosiveness_ratio(value) | -+----------+--------------------------------+ -| *Getter* | get_explosiveness_ratio() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------------+ +| *Setter* | set_explosiveness_ratio(value) | ++-----------+--------------------------------+ +| *Getter* | get_explosiveness_ratio() | ++-----------+--------------------------------+ -Time ratio between each emission. If ``0``, particles are emitted continuously. If ``1``, all particles are emitted simultaneously. Default value: ``0``. +Time ratio between each emission. If ``0``, particles are emitted continuously. If ``1``, all particles are emitted simultaneously. .. _class_Particles_property_fixed_fps: - :ref:`int` **fixed_fps** -+----------+----------------------+ -| *Setter* | set_fixed_fps(value) | -+----------+----------------------+ -| *Getter* | get_fixed_fps() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_fixed_fps(value) | ++-----------+----------------------+ +| *Getter* | get_fixed_fps() | ++-----------+----------------------+ The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. @@ -233,59 +247,69 @@ The particle system's frame rate is fixed to a value. For instance, changing the - :ref:`bool` **fract_delta** -+----------+-----------------------------+ -| *Setter* | set_fractional_delta(value) | -+----------+-----------------------------+ -| *Getter* | get_fractional_delta() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | true | ++-----------+-----------------------------+ +| *Setter* | set_fractional_delta(value) | ++-----------+-----------------------------+ +| *Getter* | get_fractional_delta() | ++-----------+-----------------------------+ -If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true``. +If ``true``, results in fractional delta calculation which has a smoother particles display effect. .. _class_Particles_property_lifetime: - :ref:`float` **lifetime** -+----------+---------------------+ -| *Setter* | set_lifetime(value) | -+----------+---------------------+ -| *Getter* | get_lifetime() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 1.0 | ++-----------+---------------------+ +| *Setter* | set_lifetime(value) | ++-----------+---------------------+ +| *Getter* | get_lifetime() | ++-----------+---------------------+ -Amount of time each particle will exist. Default value: ``1``. +Amount of time each particle will exist. .. _class_Particles_property_local_coords: - :ref:`bool` **local_coords** -+----------+----------------------------------+ -| *Setter* | set_use_local_coordinates(value) | -+----------+----------------------------------+ -| *Getter* | get_use_local_coordinates() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_use_local_coordinates(value) | ++-----------+----------------------------------+ +| *Getter* | get_use_local_coordinates() | ++-----------+----------------------------------+ -If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. +If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. .. _class_Particles_property_one_shot: - :ref:`bool` **one_shot** -+----------+---------------------+ -| *Setter* | set_one_shot(value) | -+----------+---------------------+ -| *Getter* | get_one_shot() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_one_shot(value) | ++-----------+---------------------+ +| *Getter* | get_one_shot() | ++-----------+---------------------+ -If ``true``, only ``amount`` particles will be emitted. Default value: ``false``. +If ``true``, only ``amount`` particles will be emitted. .. _class_Particles_property_preprocess: - :ref:`float` **preprocess** -+----------+-----------------------------+ -| *Setter* | set_pre_process_time(value) | -+----------+-----------------------------+ -| *Getter* | get_pre_process_time() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_pre_process_time(value) | ++-----------+-----------------------------+ +| *Getter* | get_pre_process_time() | ++-----------+-----------------------------+ Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. @@ -293,11 +317,13 @@ Amount of time to preprocess the particles before animation starts. Lets you sta - :ref:`Material` **process_material** -+----------+-----------------------------+ -| *Setter* | set_process_material(value) | -+----------+-----------------------------+ -| *Getter* | get_process_material() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | null | ++-----------+-----------------------------+ +| *Setter* | set_process_material(value) | ++-----------+-----------------------------+ +| *Getter* | get_process_material() | ++-----------+-----------------------------+ :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. @@ -305,35 +331,41 @@ Amount of time to preprocess the particles before animation starts. Lets you sta - :ref:`float` **randomness** -+----------+-----------------------------+ -| *Setter* | set_randomness_ratio(value) | -+----------+-----------------------------+ -| *Getter* | get_randomness_ratio() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_randomness_ratio(value) | ++-----------+-----------------------------+ +| *Getter* | get_randomness_ratio() | ++-----------+-----------------------------+ -Emission randomness ratio. Default value: ``0``. +Emission randomness ratio. .. _class_Particles_property_speed_scale: - :ref:`float` **speed_scale** -+----------+------------------------+ -| *Setter* | set_speed_scale(value) | -+----------+------------------------+ -| *Getter* | get_speed_scale() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1.0 | ++-----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++-----------+------------------------+ +| *Getter* | get_speed_scale() | ++-----------+------------------------+ -Speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +Speed scaling ratio. A value of ``0`` can be used to pause the particles. .. _class_Particles_property_visibility_aabb: - :ref:`AABB` **visibility_aabb** -+----------+----------------------------+ -| *Setter* | set_visibility_aabb(value) | -+----------+----------------------------+ -| *Getter* | get_visibility_aabb() | -+----------+----------------------------+ ++-----------+-----------------------------+ +| *Default* | AABB( -4, -4, -4, 8, 8, 8 ) | ++-----------+-----------------------------+ +| *Setter* | set_visibility_aabb(value) | ++-----------+-----------------------------+ +| *Getter* | get_visibility_aabb() | ++-----------+-----------------------------+ The :ref:`AABB` that determines the area of the world part of which needs to be visible on screen for the particle system to be active. diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index b6c7896c8..05ba773c7 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -19,39 +19,39 @@ Brief Description Properties ---------- -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`int` | :ref:`amount` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emitting` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`explosiveness` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_fps` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fract_delta` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`lifetime` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`local_coords` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`preprocess` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`Material` | :ref:`process_material` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`randomness` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+----------------------------------------------+----------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`visibility_rect` | -+----------------------------------------------+----------------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`int` | :ref:`amount` | 8 | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | 0 | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`emitting` | true | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`explosiveness` | 0.0 | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`int` | :ref:`fixed_fps` | 0 | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`fract_delta` | true | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`lifetime` | 1.0 | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`local_coords` | true | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`Texture` | :ref:`normal_map` | null | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`one_shot` | false | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`preprocess` | 0.0 | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`Material` | :ref:`process_material` | null | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`randomness` | 0.0 | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`speed_scale` | 1.0 | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ +| :ref:`Rect2` | :ref:`visibility_rect` | Rect2( -100, -100, 200, 200 ) | ++----------------------------------------------+----------------------------------------------------------------------+-------------------------------+ Methods ------- @@ -96,11 +96,13 @@ Property Descriptions - :ref:`int` **amount** -+----------+-------------------+ -| *Setter* | set_amount(value) | -+----------+-------------------+ -| *Getter* | get_amount() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 8 | ++-----------+-------------------+ +| *Setter* | set_amount(value) | ++-----------+-------------------+ +| *Getter* | get_amount() | ++-----------+-------------------+ Number of particles emitted in one emission cycle. @@ -108,47 +110,55 @@ Number of particles emitted in one emission cycle. - :ref:`DrawOrder` **draw_order** -+----------+-----------------------+ -| *Setter* | set_draw_order(value) | -+----------+-----------------------+ -| *Getter* | get_draw_order() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_draw_order(value) | ++-----------+-----------------------+ +| *Getter* | get_draw_order() | ++-----------+-----------------------+ -Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: :ref:`DRAW_ORDER_INDEX`. +Particle draw order. Uses ``DRAW_ORDER_*`` values. .. _class_Particles2D_property_emitting: - :ref:`bool` **emitting** -+----------+---------------------+ -| *Setter* | set_emitting(value) | -+----------+---------------------+ -| *Getter* | is_emitting() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_emitting(value) | ++-----------+---------------------+ +| *Getter* | is_emitting() | ++-----------+---------------------+ -If ``true``, particles are being emitted. Default value: ``true``. +If ``true``, particles are being emitted. .. _class_Particles2D_property_explosiveness: - :ref:`float` **explosiveness** -+----------+--------------------------------+ -| *Setter* | set_explosiveness_ratio(value) | -+----------+--------------------------------+ -| *Getter* | get_explosiveness_ratio() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------------+ +| *Setter* | set_explosiveness_ratio(value) | ++-----------+--------------------------------+ +| *Getter* | get_explosiveness_ratio() | ++-----------+--------------------------------+ -How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. +How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. .. _class_Particles2D_property_fixed_fps: - :ref:`int` **fixed_fps** -+----------+----------------------+ -| *Setter* | set_fixed_fps(value) | -+----------+----------------------+ -| *Getter* | get_fixed_fps() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_fixed_fps(value) | ++-----------+----------------------+ +| *Getter* | get_fixed_fps() | ++-----------+----------------------+ The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. @@ -156,47 +166,55 @@ The particle system's frame rate is fixed to a value. For instance, changing the - :ref:`bool` **fract_delta** -+----------+-----------------------------+ -| *Setter* | set_fractional_delta(value) | -+----------+-----------------------------+ -| *Getter* | get_fractional_delta() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | true | ++-----------+-----------------------------+ +| *Setter* | set_fractional_delta(value) | ++-----------+-----------------------------+ +| *Getter* | get_fractional_delta() | ++-----------+-----------------------------+ -If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true``. +If ``true``, results in fractional delta calculation which has a smoother particles display effect. .. _class_Particles2D_property_lifetime: - :ref:`float` **lifetime** -+----------+---------------------+ -| *Setter* | set_lifetime(value) | -+----------+---------------------+ -| *Getter* | get_lifetime() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 1.0 | ++-----------+---------------------+ +| *Setter* | set_lifetime(value) | ++-----------+---------------------+ +| *Getter* | get_lifetime() | ++-----------+---------------------+ -Amount of time each particle will exist. Default value: ``1``. +Amount of time each particle will exist. .. _class_Particles2D_property_local_coords: - :ref:`bool` **local_coords** -+----------+----------------------------------+ -| *Setter* | set_use_local_coordinates(value) | -+----------+----------------------------------+ -| *Getter* | get_use_local_coordinates() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_use_local_coordinates(value) | ++-----------+----------------------------------+ +| *Getter* | get_use_local_coordinates() | ++-----------+----------------------------------+ -If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. +If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. .. _class_Particles2D_property_normal_map: - :ref:`Texture` **normal_map** -+----------+-----------------------+ -| *Setter* | set_normal_map(value) | -+----------+-----------------------+ -| *Getter* | get_normal_map() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++-----------+-----------------------+ +| *Getter* | get_normal_map() | ++-----------+-----------------------+ Normal map to be used for the :ref:`texture` property. @@ -204,23 +222,27 @@ Normal map to be used for the :ref:`texture` - :ref:`bool` **one_shot** -+----------+---------------------+ -| *Setter* | set_one_shot(value) | -+----------+---------------------+ -| *Getter* | get_one_shot() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_one_shot(value) | ++-----------+---------------------+ +| *Getter* | get_one_shot() | ++-----------+---------------------+ -If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. +If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. .. _class_Particles2D_property_preprocess: - :ref:`float` **preprocess** -+----------+-----------------------------+ -| *Setter* | set_pre_process_time(value) | -+----------+-----------------------------+ -| *Getter* | get_pre_process_time() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_pre_process_time(value) | ++-----------+-----------------------------+ +| *Getter* | get_pre_process_time() | ++-----------+-----------------------------+ Particle system starts as if it had already run for this many seconds. @@ -228,11 +250,13 @@ Particle system starts as if it had already run for this many seconds. - :ref:`Material` **process_material** -+----------+-----------------------------+ -| *Setter* | set_process_material(value) | -+----------+-----------------------------+ -| *Getter* | get_process_material() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | null | ++-----------+-----------------------------+ +| *Setter* | set_process_material(value) | ++-----------+-----------------------------+ +| *Getter* | get_process_material() | ++-----------+-----------------------------+ :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. @@ -240,35 +264,41 @@ Particle system starts as if it had already run for this many seconds. - :ref:`float` **randomness** -+----------+-----------------------------+ -| *Setter* | set_randomness_ratio(value) | -+----------+-----------------------------+ -| *Getter* | get_randomness_ratio() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_randomness_ratio(value) | ++-----------+-----------------------------+ +| *Getter* | get_randomness_ratio() | ++-----------+-----------------------------+ -Emission lifetime randomness ratio. Default value: ``0``. +Emission lifetime randomness ratio. .. _class_Particles2D_property_speed_scale: - :ref:`float` **speed_scale** -+----------+------------------------+ -| *Setter* | set_speed_scale(value) | -+----------+------------------------+ -| *Getter* | get_speed_scale() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 1.0 | ++-----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++-----------+------------------------+ +| *Getter* | get_speed_scale() | ++-----------+------------------------+ -Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +Particle system's running speed scaling ratio. A value of ``0`` can be used to pause the particles. .. _class_Particles2D_property_texture: - :ref:`Texture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ Particle texture. If ``null``, particles will be squares. @@ -276,11 +306,13 @@ Particle texture. If ``null``, particles will be squares. - :ref:`Rect2` **visibility_rect** -+----------+----------------------------+ -| *Setter* | set_visibility_rect(value) | -+----------+----------------------------+ -| *Getter* | get_visibility_rect() | -+----------+----------------------------+ ++-----------+-------------------------------+ +| *Default* | Rect2( -100, -100, 200, 200 ) | ++-----------+-------------------------------+ +| *Setter* | set_visibility_rect(value) | ++-----------+-------------------------------+ +| *Getter* | get_visibility_rect() | ++-----------+-------------------------------+ Editor visibility helper. diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index c40d85ef5..1611d21cd 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -19,113 +19,115 @@ Particle properties for :ref:`Particles` and :ref:`Particles2D< Properties ---------- -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`angle_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`angular_velocity_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`anim_offset_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`anim_speed_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`color_ramp` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`damping_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`emission_box_extents` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`emission_color_texture` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`emission_normal_texture` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`emission_point_count` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`emission_point_texture` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`EmissionShape` | :ref:`emission_shape` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_sphere_radius` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_align_y` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_disable_z` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_rotate_y` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`flatness` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`gravity` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`hue_variation_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`linear_accel_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`orbit_velocity` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`orbit_velocity_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`orbit_velocity_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`radial_accel_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`scale_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spread` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tangential_accel_curve` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel_random` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`GradientTexture` | :ref:`trail_color_modifier` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`trail_divisor` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`CurveTexture` | :ref:`trail_size_modifier` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angle` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`angle_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angle_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angular_velocity` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`angular_velocity_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`angular_velocity_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`anim_offset` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`anim_offset_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`anim_offset_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`anim_speed` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`anim_speed_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`anim_speed_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Color` | :ref:`color` | Color( 1, 1, 1, 1 ) | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`color_ramp` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`damping` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`damping_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`damping_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`direction` | Vector3( 1, 0, 0 ) | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`emission_box_extents` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`emission_color_texture` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`emission_normal_texture` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`int` | :ref:`emission_point_count` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`emission_point_texture` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`EmissionShape` | :ref:`emission_shape` | 0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`emission_sphere_radius` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`flag_align_y` | false | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`flag_disable_z` | false | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`flag_rotate_y` | false | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`flatness` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Vector3` | :ref:`gravity` | Vector3( 0, -9.8, 0 ) | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`hue_variation` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`hue_variation_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`hue_variation_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`initial_velocity` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`initial_velocity_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`linear_accel` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`linear_accel_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`linear_accel_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`orbit_velocity` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`orbit_velocity_curve` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`orbit_velocity_random` | | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`radial_accel` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`radial_accel_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`radial_accel_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`scale` | 1.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`scale_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`scale_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`spread` | 45.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`tangential_accel` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Texture` | :ref:`tangential_accel_curve` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`tangential_accel_random` | 0.0 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`GradientTexture` | :ref:`trail_color_modifier` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`int` | :ref:`trail_divisor` | 1 | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`CurveTexture` | :ref:`trail_size_modifier` | null | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ Enumerations ------------ @@ -246,11 +248,13 @@ Property Descriptions - :ref:`float` **angle** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial rotation applied to each particle, in degrees. @@ -260,11 +264,13 @@ Only applied when :ref:`flag_disable_z` **angle_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's rotation will be animated along this :ref:`CurveTexture`. @@ -272,23 +278,27 @@ Each particle's rotation will be animated along this :ref:`CurveTexture` **angle_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Rotation randomness ratio. Default value: ``0``. +Rotation randomness ratio. .. _class_ParticlesMaterial_property_angular_velocity: - :ref:`float` **angular_velocity** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. @@ -298,11 +308,13 @@ Only applied when :ref:`flag_disable_z` **angular_velocity_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's angular velocity will vary along this :ref:`CurveTexture`. @@ -310,23 +322,27 @@ Each particle's angular velocity will vary along this :ref:`CurveTexture` **angular_velocity_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Angular velocity randomness ratio. Default value: ``0``. +Angular velocity randomness ratio. .. _class_ParticlesMaterial_property_anim_offset: - :ref:`float` **anim_offset** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Particle animation offset. @@ -334,11 +350,13 @@ Particle animation offset. - :ref:`Texture` **anim_offset_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's animation offset will vary along this :ref:`CurveTexture`. @@ -346,23 +364,27 @@ Each particle's animation offset will vary along this :ref:`CurveTexture` **anim_offset_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Animation offset randomness ratio. Default value: ``0``. +Animation offset randomness ratio. .. _class_ParticlesMaterial_property_anim_speed: - :ref:`float` **anim_speed** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Particle animation speed. @@ -370,11 +392,13 @@ Particle animation speed. - :ref:`Texture` **anim_speed_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's animation speed will vary along this :ref:`CurveTexture`. @@ -382,23 +406,27 @@ Each particle's animation speed will vary along this :ref:`CurveTexture` **anim_speed_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Animation speed randomness ratio. Default value: ``0``. +Animation speed randomness ratio. .. _class_ParticlesMaterial_property_color: - :ref:`Color` **color** -+----------+------------------+ -| *Setter* | set_color(value) | -+----------+------------------+ -| *Getter* | get_color() | -+----------+------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_color(value) | ++-----------+---------------------+ +| *Getter* | get_color() | ++-----------+---------------------+ Each particle's initial color. If the :ref:`Particles2D`'s ``texture`` is defined, it will be multiplied by this color. To have particle display color in a :ref:`SpatialMaterial` make sure to set :ref:`SpatialMaterial.vertex_color_use_as_albedo` to ``true``. @@ -406,11 +434,13 @@ Each particle's initial color. If the :ref:`Particles2D`'s `` - :ref:`Texture` **color_ramp** -+----------+-----------------------+ -| *Setter* | set_color_ramp(value) | -+----------+-----------------------+ -| *Getter* | get_color_ramp() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_color_ramp(value) | ++-----------+-----------------------+ +| *Getter* | get_color_ramp() | ++-----------+-----------------------+ Each particle's color will vary along this :ref:`GradientTexture`. @@ -418,11 +448,13 @@ Each particle's color will vary along this :ref:`GradientTexture` **damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The rate at which particles lose velocity. @@ -430,11 +462,13 @@ The rate at which particles lose velocity. - :ref:`Texture` **damping_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Damping will vary along this :ref:`CurveTexture`. @@ -442,13 +476,29 @@ Damping will vary along this :ref:`CurveTexture`. - :ref:`float` **damping_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Damping randomness ratio. Default value: ``0``. +Damping randomness ratio. + +.. _class_ParticlesMaterial_property_direction: + +- :ref:`Vector3` **direction** + ++-----------+----------------------+ +| *Default* | Vector3( 1, 0, 0 ) | ++-----------+----------------------+ +| *Setter* | set_direction(value) | ++-----------+----------------------+ +| *Getter* | get_direction() | ++-----------+----------------------+ + +Unit vector specifying the particles' emission direction. .. _class_ParticlesMaterial_property_emission_box_extents: @@ -514,13 +564,15 @@ Particles will be emitted at positions determined by sampling this texture at a - :ref:`EmissionShape` **emission_shape** -+----------+---------------------------+ -| *Setter* | set_emission_shape(value) | -+----------+---------------------------+ -| *Getter* | get_emission_shape() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_emission_shape(value) | ++-----------+---------------------------+ +| *Getter* | get_emission_shape() | ++-----------+---------------------------+ -Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: :ref:`EMISSION_SHAPE_POINT`. +Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. .. _class_ParticlesMaterial_property_emission_sphere_radius: @@ -538,11 +590,13 @@ The sphere's radius if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_SPHERE< - :ref:`bool` **flag_align_y** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ Align Y axis of particle with the direction of its velocity. @@ -550,23 +604,27 @@ Align Y axis of particle with the direction of its velocity. - :ref:`bool` **flag_disable_z** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. +If ``true``, particles will not move on the z axis. .. _class_ParticlesMaterial_property_flag_rotate_y: - :ref:`bool` **flag_rotate_y** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ If ``true``, particles rotate around Y axis by :ref:`angle`. @@ -574,35 +632,41 @@ If ``true``, particles rotate around Y axis by :ref:`angle` **flatness** -+----------+---------------------+ -| *Setter* | set_flatness(value) | -+----------+---------------------+ -| *Getter* | get_flatness() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_flatness(value) | ++-----------+---------------------+ +| *Getter* | get_flatness() | ++-----------+---------------------+ -Amount of :ref:`spread` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``. +Amount of :ref:`spread` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. .. _class_ParticlesMaterial_property_gravity: - :ref:`Vector3` **gravity** -+----------+--------------------+ -| *Setter* | set_gravity(value) | -+----------+--------------------+ -| *Getter* | get_gravity() | -+----------+--------------------+ ++-----------+-----------------------+ +| *Default* | Vector3( 0, -9.8, 0 ) | ++-----------+-----------------------+ +| *Setter* | set_gravity(value) | ++-----------+-----------------------+ +| *Getter* | get_gravity() | ++-----------+-----------------------+ -Gravity applied to every particle. Default value: ``(0, -9.8, 0)``. +Gravity applied to every particle. .. _class_ParticlesMaterial_property_hue_variation: - :ref:`float` **hue_variation** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial hue variation applied to each particle. @@ -610,11 +674,13 @@ Initial hue variation applied to each particle. - :ref:`Texture` **hue_variation_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's hue will vary along this :ref:`CurveTexture`. @@ -622,23 +688,27 @@ Each particle's hue will vary along this :ref:`CurveTexture` - :ref:`float` **hue_variation_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Hue variation randomness ratio. Default value: ``0``. +Hue variation randomness ratio. .. _class_ParticlesMaterial_property_initial_velocity: - :ref:`float` **initial_velocity** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial velocity magnitude for each particle. Direction comes from :ref:`spread` and the node's orientation. @@ -646,23 +716,27 @@ Initial velocity magnitude for each particle. Direction comes from :ref:`spread< - :ref:`float` **initial_velocity_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Initial velocity randomness ratio. Default value: ``0``. +Initial velocity randomness ratio. .. _class_ParticlesMaterial_property_linear_accel: - :ref:`float` **linear_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Linear acceleration applied to each particle in the direction of motion. @@ -670,11 +744,13 @@ Linear acceleration applied to each particle in the direction of motion. - :ref:`Texture` **linear_accel_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's linear acceleration will vary along this :ref:`CurveTexture`. @@ -682,13 +758,15 @@ Each particle's linear acceleration will vary along this :ref:`CurveTexture` **linear_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Linear acceleration randomness ratio. Default value: ``0``. +Linear acceleration randomness ratio. .. _class_ParticlesMaterial_property_orbit_velocity: @@ -726,17 +804,19 @@ Each particle's orbital velocity will vary along this :ref:`CurveTexture` **radial_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Radial acceleration applied to each particle. Makes particle accelerate away from origin. @@ -744,11 +824,13 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro - :ref:`Texture` **radial_accel_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's radial acceleration will vary along this :ref:`CurveTexture`. @@ -756,23 +838,27 @@ Each particle's radial acceleration will vary along this :ref:`CurveTexture` **radial_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Radial acceleration randomness ratio. Default value: ``0``. +Radial acceleration randomness ratio. .. _class_ParticlesMaterial_property_scale: - :ref:`float` **scale** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Initial scale applied to each particle. @@ -780,11 +866,13 @@ Initial scale applied to each particle. - :ref:`Texture` **scale_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's scale will vary along this :ref:`CurveTexture`. @@ -792,35 +880,41 @@ Each particle's scale will vary along this :ref:`CurveTexture` **scale_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Scale randomness ratio. Default value: ``0``. +Scale randomness ratio. .. _class_ParticlesMaterial_property_spread: - :ref:`float` **spread** -+----------+-------------------+ -| *Setter* | set_spread(value) | -+----------+-------------------+ -| *Getter* | get_spread() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 45.0 | ++-----------+-------------------+ +| *Setter* | set_spread(value) | ++-----------+-------------------+ +| *Getter* | get_spread() | ++-----------+-------------------+ -Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. Applied to X/Z plane and Y/Z planes. +Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Applied to X/Z plane and Y/Z planes. .. _class_ParticlesMaterial_property_tangential_accel: - :ref:`float` **tangential_accel** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. @@ -828,11 +922,13 @@ Tangential acceleration applied to each particle. Tangential acceleration is per - :ref:`Texture` **tangential_accel_curve** -+----------+--------------------------+ -| *Setter* | set_param_texture(value) | -+----------+--------------------------+ -| *Getter* | get_param_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_param_texture() | ++-----------+--------------------------+ Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. @@ -840,23 +936,27 @@ Each particle's tangential acceleration will vary along this :ref:`CurveTexture< - :ref:`float` **tangential_accel_random** -+----------+-----------------------------+ -| *Setter* | set_param_randomness(value) | -+----------+-----------------------------+ -| *Getter* | get_param_randomness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++-----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++-----------+-----------------------------+ -Tangential acceleration randomness ratio. Default value: ``0``. +Tangential acceleration randomness ratio. .. _class_ParticlesMaterial_property_trail_color_modifier: - :ref:`GradientTexture` **trail_color_modifier** -+----------+---------------------------------+ -| *Setter* | set_trail_color_modifier(value) | -+----------+---------------------------------+ -| *Getter* | get_trail_color_modifier() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | null | ++-----------+---------------------------------+ +| *Setter* | set_trail_color_modifier(value) | ++-----------+---------------------------------+ +| *Getter* | get_trail_color_modifier() | ++-----------+---------------------------------+ Trail particles' color will vary along this :ref:`GradientTexture`. @@ -864,11 +964,13 @@ Trail particles' color will vary along this :ref:`GradientTexture` **trail_divisor** -+----------+--------------------------+ -| *Setter* | set_trail_divisor(value) | -+----------+--------------------------+ -| *Getter* | get_trail_divisor() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1 | ++-----------+--------------------------+ +| *Setter* | set_trail_divisor(value) | ++-----------+--------------------------+ +| *Getter* | get_trail_divisor() | ++-----------+--------------------------+ Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaining particles will be used as trail(s). @@ -876,11 +978,13 @@ Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaini - :ref:`CurveTexture` **trail_size_modifier** -+----------+--------------------------------+ -| *Setter* | set_trail_size_modifier(value) | -+----------+--------------------------------+ -| *Getter* | get_trail_size_modifier() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | null | ++-----------+--------------------------------+ +| *Setter* | set_trail_size_modifier(value) | ++-----------+--------------------------------+ +| *Getter* | get_trail_size_modifier() | ++-----------+--------------------------------+ Trail particles' size will vary along this :ref:`CurveTexture`. diff --git a/classes/class_path.rst b/classes/class_path.rst index d5fb46af7..cbc80c627 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -19,9 +19,9 @@ Contains a :ref:`Curve3D` path for :ref:`PathFollow` | :ref:`curve` | -+-------------------------------+-----------------------------------------+ ++-------------------------------+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Curve3D` | :ref:`curve` | Object(Curve3D,"resource_local_to_scene":false,"resource_name":"","bake_interval":0.2,"_data":{ "points": PoolVector3Array( ), "tilts": PoolRealArray( ) },"up_vector_enabled":true,"script":null) | ++-------------------------------+-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -46,11 +46,13 @@ Property Descriptions - :ref:`Curve3D` **curve** -+----------+------------------+ -| *Setter* | set_curve(value) | -+----------+------------------+ -| *Getter* | get_curve() | -+----------+------------------+ ++-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | Object(Curve3D,"resource_local_to_scene":false,"resource_name":"","bake_interval":0.2,"_data":{ "points": PoolVector3Array( ), "tilts": PoolRealArray( ) },"up_vector_enabled":true,"script":null) | ++-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Setter* | set_curve(value) | ++-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Getter* | get_curve() | ++-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ A :ref:`Curve3D` describing the path. diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 8f536906a..4a0b656e1 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -19,9 +19,9 @@ Contains a :ref:`Curve2D` path for :ref:`PathFollow2D` | :ref:`curve` | -+-------------------------------+-------------------------------------------+ ++-------------------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Curve2D` | :ref:`curve` | Object(Curve2D,"resource_local_to_scene":false,"resource_name":"","bake_interval":5.0,"_data":{ "points": PoolVector2Array( ) },"script":null) | ++-------------------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`Curve2D` **curve** -+----------+------------------+ -| *Setter* | set_curve(value) | -+----------+------------------+ -| *Getter* | get_curve() | -+----------+------------------+ ++-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | Object(Curve2D,"resource_local_to_scene":false,"resource_name":"","bake_interval":5.0,"_data":{ "points": PoolVector2Array( ) },"script":null) | ++-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Setter* | set_curve(value) | ++-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Getter* | get_curve() | ++-----------+--------------------------------------------------------------------------------------------------------------------------------------------------+ A :ref:`Curve2D` describing the path. diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 0fd86ab42..234dce840 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -19,21 +19,21 @@ Point sampler for a :ref:`Path`. Properties ---------- -+---------------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`cubic_interp` | -+---------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`h_offset` | -+---------------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+---------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`offset` | -+---------------------------------------------------+---------------------------------------------------------------+ -| :ref:`RotationMode` | :ref:`rotation_mode` | -+---------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`unit_offset` | -+---------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`v_offset` | -+---------------------------------------------------+---------------------------------------------------------------+ ++---------------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`cubic_interp` | true | ++---------------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`h_offset` | 0.0 | ++---------------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`loop` | true | ++---------------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`offset` | 0.0 | ++---------------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`RotationMode` | :ref:`rotation_mode` | 3 | ++---------------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`unit_offset` | 0.0 | ++---------------------------------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`v_offset` | 0.0 | ++---------------------------------------------------+---------------------------------------------------------------+------+ Enumerations ------------ @@ -76,11 +76,13 @@ Property Descriptions - :ref:`bool` **cubic_interp** -+----------+--------------------------------+ -| *Setter* | set_cubic_interpolation(value) | -+----------+--------------------------------+ -| *Getter* | get_cubic_interpolation() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | true | ++-----------+--------------------------------+ +| *Setter* | set_cubic_interpolation(value) | ++-----------+--------------------------------+ +| *Getter* | get_cubic_interpolation() | ++-----------+--------------------------------+ If ``true``, the position between two cached points is interpolated cubically, and linearly otherwise. @@ -92,11 +94,13 @@ There are two answers to this problem: either increase the number of cached poin - :ref:`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 node's offset along the curve. @@ -104,11 +108,13 @@ The node's offset along the curve. - :ref:`bool` **loop** -+----------+-----------------+ -| *Setter* | set_loop(value) | -+----------+-----------------+ -| *Getter* | has_loop() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | true | ++-----------+-----------------+ +| *Setter* | set_loop(value) | ++-----------+-----------------+ +| *Getter* | has_loop() | ++-----------+-----------------+ If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. @@ -116,11 +122,13 @@ If ``true``, any offset outside the path's length will wrap around, instead of s - :ref:`float` **offset** -+----------+-------------------+ -| *Setter* | set_offset(value) | -+----------+-------------------+ -| *Getter* | get_offset() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.0 | ++-----------+-------------------+ +| *Setter* | set_offset(value) | ++-----------+-------------------+ +| *Getter* | get_offset() | ++-----------+-------------------+ The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. @@ -128,11 +136,13 @@ The distance from the first vertex, measured in 3D units along the path. This se - :ref:`RotationMode` **rotation_mode** -+----------+--------------------------+ -| *Setter* | set_rotation_mode(value) | -+----------+--------------------------+ -| *Getter* | get_rotation_mode() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 3 | ++-----------+--------------------------+ +| *Setter* | set_rotation_mode(value) | ++-----------+--------------------------+ +| *Getter* | get_rotation_mode() | ++-----------+--------------------------+ Allows or forbids rotation on one or more axes, depending on the :ref:`RotationMode` constants being used. @@ -140,11 +150,13 @@ Allows or forbids rotation on one or more axes, depending on the :ref:`RotationM - :ref:`float` **unit_offset** -+----------+------------------------+ -| *Setter* | set_unit_offset(value) | -+----------+------------------------+ -| *Getter* | get_unit_offset() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_unit_offset(value) | ++-----------+------------------------+ +| *Getter* | get_unit_offset() | ++-----------+------------------------+ The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. @@ -152,11 +164,13 @@ The distance from the first vertex, considering 0.0 as the first vertex and 1.0 - :ref:`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 node's offset perpendicular to the curve. diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index 13716dd10..aa9fa4726 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -19,23 +19,23 @@ Point sampler for a :ref:`Path2D`. Properties ---------- -+---------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`cubic_interp` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`h_offset` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`lookahead` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`offset` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`rotate` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`unit_offset` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`v_offset` | -+---------------------------+---------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`cubic_interp` | true | ++---------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`h_offset` | 0.0 | ++---------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`lookahead` | 4.0 | ++---------------------------+---------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`loop` | true | ++---------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`offset` | 0.0 | ++---------------------------+---------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`rotate` | true | ++---------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`unit_offset` | 0.0 | ++---------------------------+---------------------------------------------------------------+------+ +| :ref:`float` | :ref:`v_offset` | 0.0 | ++---------------------------+---------------------------------------------------------------+------+ Description ----------- @@ -51,11 +51,13 @@ Property Descriptions - :ref:`bool` **cubic_interp** -+----------+--------------------------------+ -| *Setter* | set_cubic_interpolation(value) | -+----------+--------------------------------+ -| *Getter* | get_cubic_interpolation() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | true | ++-----------+--------------------------------+ +| *Setter* | set_cubic_interpolation(value) | ++-----------+--------------------------------+ +| *Getter* | get_cubic_interpolation() | ++-----------+--------------------------------+ If ``true``, the position between two cached points is interpolated cubically, and linearly otherwise. @@ -67,11 +69,13 @@ There are two answers to this problem: either increase the number of cached poin - :ref:`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 node's offset along the curve. @@ -79,23 +83,27 @@ The node's offset along the curve. - :ref:`float` **lookahead** -+----------+----------------------+ -| *Setter* | set_lookahead(value) | -+----------+----------------------+ -| *Getter* | get_lookahead() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 4.0 | ++-----------+----------------------+ +| *Setter* | set_lookahead(value) | ++-----------+----------------------+ +| *Getter* | get_lookahead() | ++-----------+----------------------+ -How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations. Default value: ``4``. +How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations. .. _class_PathFollow2D_property_loop: - :ref:`bool` **loop** -+----------+-----------------+ -| *Setter* | set_loop(value) | -+----------+-----------------+ -| *Getter* | has_loop() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | true | ++-----------+-----------------+ +| *Setter* | set_loop(value) | ++-----------+-----------------+ +| *Getter* | has_loop() | ++-----------+-----------------+ If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. @@ -103,11 +111,13 @@ If ``true``, any offset outside the path's length will wrap around, instead of s - :ref:`float` **offset** -+----------+-------------------+ -| *Setter* | set_offset(value) | -+----------+-------------------+ -| *Getter* | get_offset() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.0 | ++-----------+-------------------+ +| *Setter* | set_offset(value) | ++-----------+-------------------+ +| *Getter* | get_offset() | ++-----------+-------------------+ The distance along the path in pixels. @@ -115,11 +125,13 @@ The distance along the path in pixels. - :ref:`bool` **rotate** -+----------+-------------------+ -| *Setter* | set_rotate(value) | -+----------+-------------------+ -| *Getter* | is_rotating() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_rotate(value) | ++-----------+-------------------+ +| *Getter* | is_rotating() | ++-----------+-------------------+ If ``true``, this node rotates to follow the path, making its descendants rotate. @@ -127,11 +139,13 @@ If ``true``, this node rotates to follow the path, making its descendants rotate - :ref:`float` **unit_offset** -+----------+------------------------+ -| *Setter* | set_unit_offset(value) | -+----------+------------------------+ -| *Getter* | get_unit_offset() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_unit_offset(value) | ++-----------+------------------------+ +| *Getter* | get_unit_offset() | ++-----------+------------------------+ The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. @@ -139,11 +153,13 @@ The distance along the path as a number in the range 0.0 (for the first vertex) - :ref:`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 node's offset perpendicular to the curve. diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index 9eda4abb0..096f4a52e 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -19,23 +19,23 @@ Brief Description Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Transform` | :ref:`body_offset` | -+-----------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_scale` | -+-----------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Transform` | :ref:`joint_offset` | -+-----------------------------------------------+-----------------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_type` | -+-----------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`mass` | -+-----------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`weight` | -+-----------------------------------------------+-----------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`body_offset` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | 0.0 | ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`friction` | 1.0 | ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`gravity_scale` | 1.0 | ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`joint_offset` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`JointType` | :ref:`joint_type` | 0 | ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`mass` | 1.0 | ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`weight` | 9.8 | ++-----------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------+ Methods ------- @@ -88,81 +88,97 @@ Property Descriptions - :ref:`Transform` **body_offset** -+----------+------------------------+ -| *Setter* | set_body_offset(value) | -+----------+------------------------+ -| *Getter* | get_body_offset() | -+----------+------------------------+ ++-----------+-------------------------------------------------+ +| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------+-------------------------------------------------+ +| *Setter* | set_body_offset(value) | ++-----------+-------------------------------------------------+ +| *Getter* | get_body_offset() | ++-----------+-------------------------------------------------+ .. _class_PhysicalBone_property_bounce: - :ref:`float` **bounce** -+----------+-------------------+ -| *Setter* | set_bounce(value) | -+----------+-------------------+ -| *Getter* | get_bounce() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.0 | ++-----------+-------------------+ +| *Setter* | set_bounce(value) | ++-----------+-------------------+ +| *Getter* | get_bounce() | ++-----------+-------------------+ .. _class_PhysicalBone_property_friction: - :ref:`float` **friction** -+----------+---------------------+ -| *Setter* | set_friction(value) | -+----------+---------------------+ -| *Getter* | get_friction() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 1.0 | ++-----------+---------------------+ +| *Setter* | set_friction(value) | ++-----------+---------------------+ +| *Getter* | get_friction() | ++-----------+---------------------+ .. _class_PhysicalBone_property_gravity_scale: - :ref:`float` **gravity_scale** -+----------+--------------------------+ -| *Setter* | set_gravity_scale(value) | -+----------+--------------------------+ -| *Getter* | get_gravity_scale() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_gravity_scale(value) | ++-----------+--------------------------+ +| *Getter* | get_gravity_scale() | ++-----------+--------------------------+ .. _class_PhysicalBone_property_joint_offset: - :ref:`Transform` **joint_offset** -+----------+-------------------------+ -| *Setter* | set_joint_offset(value) | -+----------+-------------------------+ -| *Getter* | get_joint_offset() | -+----------+-------------------------+ ++-----------+-------------------------------------------------+ +| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------+-------------------------------------------------+ +| *Setter* | set_joint_offset(value) | ++-----------+-------------------------------------------------+ +| *Getter* | get_joint_offset() | ++-----------+-------------------------------------------------+ .. _class_PhysicalBone_property_joint_type: - :ref:`JointType` **joint_type** -+----------+-----------------------+ -| *Setter* | set_joint_type(value) | -+----------+-----------------------+ -| *Getter* | get_joint_type() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_joint_type(value) | ++-----------+-----------------------+ +| *Getter* | get_joint_type() | ++-----------+-----------------------+ .. _class_PhysicalBone_property_mass: - :ref:`float` **mass** -+----------+-----------------+ -| *Setter* | set_mass(value) | -+----------+-----------------+ -| *Getter* | get_mass() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 1.0 | ++-----------+-----------------+ +| *Setter* | set_mass(value) | ++-----------+-----------------+ +| *Getter* | get_mass() | ++-----------+-----------------+ .. _class_PhysicalBone_property_weight: - :ref:`float` **weight** -+----------+-------------------+ -| *Setter* | set_weight(value) | -+----------+-------------------+ -| *Getter* | get_weight() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 9.8 | ++-----------+-------------------+ +| *Setter* | set_weight(value) | ++-----------+-------------------+ +| *Getter* | get_weight() | ++-----------+-------------------+ Method Descriptions ------------------- diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 3cf1d4ca3..627431661 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -19,23 +19,23 @@ Parameters to be sent to a 2D shape physics query. Properties ---------- -+---------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_areas` | -+---------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_bodies` | -+---------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+---------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`exclude` | -+---------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+---------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion` | -+---------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_rid` | -+---------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+----------------------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | false | ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | true | ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ +| :ref:`int` | :ref:`collision_layer` | 2147483647 | ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Array` | :ref:`exclude` | [ ] | ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ +| :ref:`float` | :ref:`margin` | 0.0 | ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Vector2` | :ref:`motion` | Vector2( 0, 0 ) | ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ +| :ref:`RID` | :ref:`shape_rid` | | ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | Transform2D( 1, 0, 0, 1, 0, 0 ) | ++---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+ Methods ------- @@ -56,31 +56,37 @@ Property Descriptions - :ref:`bool` **collide_with_areas** -+----------+---------------------------------+ -| *Setter* | set_collide_with_areas(value) | -+----------+---------------------------------+ -| *Getter* | is_collide_with_areas_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ .. _class_Physics2DShapeQueryParameters_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** -+----------+----------------------------------+ -| *Setter* | set_collide_with_bodies(value) | -+----------+----------------------------------+ -| *Getter* | is_collide_with_bodies_enabled() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ .. _class_Physics2DShapeQueryParameters_property_collision_layer: - :ref:`int` **collision_layer** -+----------+----------------------------+ -| *Setter* | set_collision_layer(value) | -+----------+----------------------------+ -| *Getter* | get_collision_layer() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 2147483647 | ++-----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++-----------+----------------------------+ +| *Getter* | get_collision_layer() | ++-----------+----------------------------+ The physics layer the query should be made on. @@ -88,11 +94,13 @@ The physics layer the query should be made on. - :ref:`Array` **exclude** -+----------+--------------------+ -| *Setter* | set_exclude(value) | -+----------+--------------------+ -| *Getter* | get_exclude() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | [ ] | ++-----------+--------------------+ +| *Setter* | set_exclude(value) | ++-----------+--------------------+ +| *Getter* | get_exclude() | ++-----------+--------------------+ The list of objects or object :ref:`RID`\ s, that will be excluded from collisions. @@ -100,11 +108,13 @@ The list of objects or object :ref:`RID`\ s, that will be excluded fr - :ref:`float` **margin** -+----------+-------------------+ -| *Setter* | set_margin(value) | -+----------+-------------------+ -| *Getter* | get_margin() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.0 | ++-----------+-------------------+ +| *Setter* | set_margin(value) | ++-----------+-------------------+ +| *Getter* | get_margin() | ++-----------+-------------------+ The collision margin for the shape. @@ -112,11 +122,13 @@ The collision margin for the shape. - :ref:`Vector2` **motion** -+----------+-------------------+ -| *Setter* | set_motion(value) | -+----------+-------------------+ -| *Getter* | get_motion() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------+ +| *Setter* | set_motion(value) | ++-----------+-------------------+ +| *Getter* | get_motion() | ++-----------+-------------------+ The motion of the shape being queried for. @@ -136,11 +148,13 @@ The :ref:`RID` of the queried shape. See also :ref:`set_shape` **transform** -+----------+----------------------+ -| *Setter* | set_transform(value) | -+----------+----------------------+ -| *Getter* | get_transform() | -+----------+----------------------+ ++-----------+---------------------------------+ +| *Default* | Transform2D( 1, 0, 0, 1, 0, 0 ) | ++-----------+---------------------------------+ +| *Setter* | set_transform(value) | ++-----------+---------------------------------+ +| *Getter* | get_transform() | ++-----------+---------------------------------+ the transform matrix of the queried shape. diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index 0a0c68feb..0caea40e5 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -19,25 +19,25 @@ Brief Description Properties ---------- -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_id` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`collider_rid` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_shape` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`collider_velocity` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`collision_normal` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`collision_point` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion_remainder` | -+-------------------------------+--------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Object` | :ref:`collider` | null | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`collider_id` | 0 | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`RID` | :ref:`collider_rid` | | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`collider_shape` | 0 | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`collider_velocity` | Vector2( 0, 0 ) | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`collision_normal` | Vector2( 0, 0 ) | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`collision_point` | Vector2( 0, 0 ) | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`motion` | Vector2( 0, 0 ) | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`motion_remainder` | Vector2( 0, 0 ) | ++-------------------------------+--------------------------------------------------------------------------------------+-----------------+ Property Descriptions --------------------- @@ -46,17 +46,21 @@ Property Descriptions - :ref:`Object` **collider** -+----------+----------------+ -| *Getter* | get_collider() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | null | ++-----------+----------------+ +| *Getter* | get_collider() | ++-----------+----------------+ .. _class_Physics2DTestMotionResult_property_collider_id: - :ref:`int` **collider_id** -+----------+-------------------+ -| *Getter* | get_collider_id() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0 | ++-----------+-------------------+ +| *Getter* | get_collider_id() | ++-----------+-------------------+ .. _class_Physics2DTestMotionResult_property_collider_rid: @@ -70,47 +74,59 @@ Property Descriptions - :ref:`int` **collider_shape** -+----------+----------------------+ -| *Getter* | get_collider_shape() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Getter* | get_collider_shape() | ++-----------+----------------------+ .. _class_Physics2DTestMotionResult_property_collider_velocity: - :ref:`Vector2` **collider_velocity** -+----------+-------------------------+ -| *Getter* | get_collider_velocity() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------------+ +| *Getter* | get_collider_velocity() | ++-----------+-------------------------+ .. _class_Physics2DTestMotionResult_property_collision_normal: - :ref:`Vector2` **collision_normal** -+----------+------------------------+ -| *Getter* | get_collision_normal() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+------------------------+ +| *Getter* | get_collision_normal() | ++-----------+------------------------+ .. _class_Physics2DTestMotionResult_property_collision_point: - :ref:`Vector2` **collision_point** -+----------+-----------------------+ -| *Getter* | get_collision_point() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------------+ +| *Getter* | get_collision_point() | ++-----------+-----------------------+ .. _class_Physics2DTestMotionResult_property_motion: - :ref:`Vector2` **motion** -+----------+--------------+ -| *Getter* | get_motion() | -+----------+--------------+ ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ +| *Getter* | get_motion() | ++-----------+-----------------+ .. _class_Physics2DTestMotionResult_property_motion_remainder: - :ref:`Vector2` **motion_remainder** -+----------+------------------------+ -| *Getter* | get_motion_remainder() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+------------------------+ +| *Getter* | get_motion_remainder() | ++-----------+------------------------+ diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 616c1452c..3828b595e 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -21,11 +21,11 @@ Base class for all objects affected by physics in 3D space. Properties ---------- -+-----------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-----------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-----------------------+--------------------------------------------------------------------+ ++-----------------------+--------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++-----------------------+--------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++-----------------------+--------------------------------------------------------------------+---+ Methods ------- @@ -63,11 +63,13 @@ Property Descriptions - :ref:`int` **collision_layer** -+----------+----------------------------+ -| *Setter* | set_collision_layer(value) | -+----------+----------------------------+ -| *Getter* | get_collision_layer() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1 | ++-----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++-----------+----------------------------+ +| *Getter* | get_collision_layer() | ++-----------+----------------------------+ The physics layers this area is in. @@ -75,22 +77,20 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. -Default value: 1 (the first layer/bit is enabled). - .. _class_PhysicsBody_property_collision_mask: - :ref:`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 for collisions. -Default value: 1 (the first layer/bit is enabled). - Method Descriptions ------------------- diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 318dccb66..e3fadf38c 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -21,13 +21,13 @@ Base class for all objects affected by physics in 2D space. Properties ---------- -+-----------------------+----------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-----------------------+----------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-----------------------+----------------------------------------------------------------------+ -| :ref:`int` | :ref:`layers` | -+-----------------------+----------------------------------------------------------------------+ ++-----------------------+----------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++-----------------------+----------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++-----------------------+----------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`layers` | | ++-----------------------+----------------------------------------------------------------------+---+ Methods ------- @@ -65,11 +65,13 @@ Property Descriptions - :ref:`int` **collision_layer** -+----------+----------------------------+ -| *Setter* | set_collision_layer(value) | -+----------+----------------------------+ -| *Getter* | get_collision_layer() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1 | ++-----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++-----------+----------------------------+ +| *Getter* | get_collision_layer() | ++-----------+----------------------------+ The physics layers this area is in. @@ -77,22 +79,20 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. -Default value: 1 (the first layer/bit is enabled). - .. _class_PhysicsBody2D_property_collision_mask: - :ref:`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 for collisions. -Default value: 1 (the first layer/bit is enabled). - .. _class_PhysicsBody2D_property_layers: - :ref:`int` **layers** diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 1c45e9150..1ef312874 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -19,15 +19,15 @@ A material for physics properties. Properties ---------- -+---------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`absorbent` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+---------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`rough` | -+---------------------------+------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`absorbent` | false | ++---------------------------+------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`bounce` | 0.0 | ++---------------------------+------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`friction` | 1.0 | ++---------------------------+------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`rough` | false | ++---------------------------+------------------------------------------------------------+-------+ Description ----------- @@ -41,43 +41,51 @@ Property Descriptions - :ref:`bool` **absorbent** -+----------+----------------------+ -| *Setter* | set_absorbent(value) | -+----------+----------------------+ -| *Getter* | is_absorbent() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_absorbent(value) | ++-----------+----------------------+ +| *Getter* | is_absorbent() | ++-----------+----------------------+ .. _class_PhysicsMaterial_property_bounce: - :ref:`float` **bounce** -+----------+-------------------+ -| *Setter* | set_bounce(value) | -+----------+-------------------+ -| *Getter* | get_bounce() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.0 | ++-----------+-------------------+ +| *Setter* | set_bounce(value) | ++-----------+-------------------+ +| *Getter* | get_bounce() | ++-----------+-------------------+ -The body's bounciness. Default value: ``0``. +The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). .. _class_PhysicsMaterial_property_friction: - :ref:`float` **friction** -+----------+---------------------+ -| *Setter* | set_friction(value) | -+----------+---------------------+ -| *Getter* | get_friction() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 1.0 | ++-----------+---------------------+ +| *Setter* | set_friction(value) | ++-----------+---------------------+ +| *Getter* | get_friction() | ++-----------+---------------------+ -The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. +The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). .. _class_PhysicsMaterial_property_rough: - :ref:`bool` **rough** -+----------+------------------+ -| *Setter* | set_rough(value) | -+----------+------------------+ -| *Getter* | is_rough() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | false | ++-----------+------------------+ +| *Setter* | set_rough(value) | ++-----------+------------------+ +| *Getter* | is_rough() | ++-----------+------------------+ diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 31f6a7649..01a9c49d0 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -460,7 +460,7 @@ The swing span defines, how much rotation will not get corrected allong the swin Could be defined as looseness in the :ref:`ConeTwistJoint`. -If below 0.05, this behavior is locked. Default value: ``PI/4``. +If below 0.05, this behavior is locked. - **CONE_TWIST_JOINT_TWIST_SPAN** = **1** --- Twist is the rotation around the twist axis, this value defined how far the joint can twist. diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 69a851db8..32617234a 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -19,21 +19,21 @@ Brief Description Properties ---------- -+-----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_areas` | -+-----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_bodies` | -+-----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`exclude` | -+-----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+-----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_rid` | -+-----------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`transform` | -+-----------------------------------+--------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | false | ++-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | true | ++-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | 2147483647 | ++-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Array` | :ref:`exclude` | [ ] | ++-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`margin` | 0.0 | ++-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`RID` | :ref:`shape_rid` | | ++-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`transform` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------------------+ Methods ------- @@ -49,51 +49,61 @@ Property Descriptions - :ref:`bool` **collide_with_areas** -+----------+---------------------------------+ -| *Setter* | set_collide_with_areas(value) | -+----------+---------------------------------+ -| *Getter* | is_collide_with_areas_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ .. _class_PhysicsShapeQueryParameters_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** -+----------+----------------------------------+ -| *Setter* | set_collide_with_bodies(value) | -+----------+----------------------------------+ -| *Getter* | is_collide_with_bodies_enabled() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ .. _class_PhysicsShapeQueryParameters_property_collision_mask: - :ref:`int` **collision_mask** -+----------+---------------------------+ -| *Setter* | set_collision_mask(value) | -+----------+---------------------------+ -| *Getter* | get_collision_mask() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 2147483647 | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_collision_mask() | ++-----------+---------------------------+ .. _class_PhysicsShapeQueryParameters_property_exclude: - :ref:`Array` **exclude** -+----------+--------------------+ -| *Setter* | set_exclude(value) | -+----------+--------------------+ -| *Getter* | get_exclude() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | [ ] | ++-----------+--------------------+ +| *Setter* | set_exclude(value) | ++-----------+--------------------+ +| *Getter* | get_exclude() | ++-----------+--------------------+ .. _class_PhysicsShapeQueryParameters_property_margin: - :ref:`float` **margin** -+----------+-------------------+ -| *Setter* | set_margin(value) | -+----------+-------------------+ -| *Getter* | get_margin() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.0 | ++-----------+-------------------+ +| *Setter* | set_margin(value) | ++-----------+-------------------+ +| *Getter* | get_margin() | ++-----------+-------------------+ .. _class_PhysicsShapeQueryParameters_property_shape_rid: @@ -109,11 +119,13 @@ Property Descriptions - :ref:`Transform` **transform** -+----------+----------------------+ -| *Setter* | set_transform(value) | -+----------+----------------------+ -| *Getter* | get_transform() | -+----------+----------------------+ ++-----------+-------------------------------------------------+ +| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------+-------------------------------------------------+ +| *Setter* | set_transform(value) | ++-----------+-------------------------------------------------+ +| *Getter* | get_transform() | ++-----------+-------------------------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index cbcb0959f..a95fc12c4 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -19,13 +19,13 @@ Pin joint for 3D shapes. Properties ---------- -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params/bias` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params/damping` | -+---------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params/impulse_clamp` | -+---------------------------+---------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`params/bias` | 0.3 | ++---------------------------+---------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`params/damping` | 1.0 | ++---------------------------+---------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`params/impulse_clamp` | 0.0 | ++---------------------------+---------------------------------------------------------------------------+-----+ Enumerations ------------ @@ -58,11 +58,13 @@ Property Descriptions - :ref:`float` **params/bias** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.3 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. @@ -70,11 +72,13 @@ The force with which the pinned objects stay in positional relation to each othe - :ref:`float` **params/damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. @@ -82,11 +86,13 @@ The force with which the pinned objects stay in velocity relation to each other. - :ref:`float` **params/impulse_clamp** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ If above 0, this value is the maximum value for an impulse that this Joint produces. diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index f9c51cf13..e03a96665 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -19,9 +19,9 @@ Pin Joint for 2D shapes. Properties ---------- -+---------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`softness` | -+---------------------------+-----------------------------------------------------+ ++---------------------------+-----------------------------------------------------+-----+ +| :ref:`float` | :ref:`softness` | 0.0 | ++---------------------------+-----------------------------------------------------+-----+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`float` **softness** -+----------+---------------------+ -| *Setter* | set_softness(value) | -+----------+---------------------+ -| *Getter* | get_softness() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_softness(value) | ++-----------+---------------------+ +| *Getter* | get_softness() | ++-----------+---------------------+ The higher this value, the more the bond to the pinned partner can flex. diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 618ffcaf4..04be8da7d 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -17,17 +17,17 @@ Plane in hessian form. Properties ---------- -+-------------------------------+--------------------------------------------+ -| :ref:`float` | :ref:`d` | -+-------------------------------+--------------------------------------------+ -| :ref:`Vector3` | :ref:`normal` | -+-------------------------------+--------------------------------------------+ -| :ref:`float` | :ref:`x` | -+-------------------------------+--------------------------------------------+ -| :ref:`float` | :ref:`y` | -+-------------------------------+--------------------------------------------+ -| :ref:`float` | :ref:`z` | -+-------------------------------+--------------------------------------------+ ++-------------------------------+--------------------------------------------+--------------------+ +| :ref:`float` | :ref:`d` | 0.0 | ++-------------------------------+--------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`normal` | Vector3( 0, 0, 0 ) | ++-------------------------------+--------------------------------------------+--------------------+ +| :ref:`float` | :ref:`x` | 0.0 | ++-------------------------------+--------------------------------------------+--------------------+ +| :ref:`float` | :ref:`y` | 0.0 | ++-------------------------------+--------------------------------------------+--------------------+ +| :ref:`float` | :ref:`z` | 0.0 | ++-------------------------------+--------------------------------------------+--------------------+ Methods ------- @@ -92,22 +92,42 @@ Property Descriptions - :ref:`float` **d** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + .. _class_Plane_property_normal: - :ref:`Vector3` **normal** ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ + .. _class_Plane_property_x: - :ref:`float` **x** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + .. _class_Plane_property_y: - :ref:`float` **y** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + .. _class_Plane_property_z: - :ref:`float` **z** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + Method Descriptions ------------------- diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 3da58831d..068f2bc42 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -19,13 +19,13 @@ Class representing a planar :ref:`PrimitiveMesh`. Properties ---------- -+-------------------------------+------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+-------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_depth` | -+-------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_width` | -+-------------------------------+------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`size` | Vector2( 2, 2 ) | ++-------------------------------+------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`subdivide_depth` | 0 | ++-------------------------------+------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`subdivide_width` | 0 | ++-------------------------------+------------------------------------------------------------------+-----------------+ Description ----------- @@ -39,35 +39,41 @@ Property Descriptions - :ref:`Vector2` **size** -+----------+-----------------+ -| *Setter* | set_size(value) | -+----------+-----------------+ -| *Getter* | get_size() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | Vector2( 2, 2 ) | ++-----------+-----------------+ +| *Setter* | set_size(value) | ++-----------+-----------------+ +| *Getter* | get_size() | ++-----------+-----------------+ -Size of the generated plane. Defaults to (2.0, 2.0). +Size of the generated plane. .. _class_PlaneMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** -+----------+----------------------------+ -| *Setter* | set_subdivide_depth(value) | -+----------+----------------------------+ -| *Getter* | get_subdivide_depth() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_subdivide_depth(value) | ++-----------+----------------------------+ +| *Getter* | get_subdivide_depth() | ++-----------+----------------------------+ -Number of subdivision along the Z axis. Defaults to 0. +Number of subdivision along the Z axis. .. _class_PlaneMesh_property_subdivide_width: - :ref:`int` **subdivide_width** -+----------+----------------------------+ -| *Setter* | set_subdivide_width(value) | -+----------+----------------------------+ -| *Getter* | get_subdivide_width() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_subdivide_width(value) | ++-----------+----------------------------+ +| *Getter* | get_subdivide_width() | ++-----------+----------------------------+ -Number of subdivision along the X axis. Defaults to 0. +Number of subdivision along the X axis. diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 45f70ca87..94cf01a1c 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+---------------------------+-----------------------------------------------+ -| :ref:`Plane` | :ref:`plane` | -+---------------------------+-----------------------------------------------+ ++---------------------------+-----------------------------------------------+---------------------+ +| :ref:`Plane` | :ref:`plane` | Plane( 0, 1, 0, 0 ) | ++---------------------------+-----------------------------------------------+---------------------+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`Plane` **plane** -+----------+------------------+ -| *Setter* | set_plane(value) | -+----------+------------------+ -| *Getter* | get_plane() | -+----------+------------------+ ++-----------+---------------------+ +| *Default* | Plane( 0, 1, 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_plane(value) | ++-----------+---------------------+ +| *Getter* | get_plane() | ++-----------+---------------------+ diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 7da588b3e..bd88045e5 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -19,41 +19,41 @@ A 2D polygon. Properties ---------- -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`antialiased` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`bones` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`internal_vertex_count` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`invert_border` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`invert_enable` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`polygons` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`skeleton` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`texture_offset` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`texture_rotation` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`texture_rotation_degrees` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`texture_scale` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`uv` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`vertex_colors` | -+-------------------------------------------------+------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`antialiased` | false | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`Array` | :ref:`bones` | [ ] | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`Color` | :ref:`color` | Color( 1, 1, 1, 1 ) | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`int` | :ref:`internal_vertex_count` | 0 | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`float` | :ref:`invert_border` | 100.0 | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`invert_enable` | false | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | PoolVector2Array( ) | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`Array` | :ref:`polygons` | [ ] | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`NodePath` | :ref:`skeleton` | NodePath("") | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`Vector2` | :ref:`texture_offset` | Vector2( 0, 0 ) | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`float` | :ref:`texture_rotation` | | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`float` | :ref:`texture_rotation_degrees` | 0.0 | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`Vector2` | :ref:`texture_scale` | Vector2( 1, 1 ) | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`PoolVector2Array` | :ref:`uv` | PoolVector2Array( ) | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ +| :ref:`PoolColorArray` | :ref:`vertex_colors` | PoolColorArray( ) | ++-------------------------------------------------+------------------------------------------------------------------------------------+----------------------+ Methods ------- @@ -88,27 +88,35 @@ Property Descriptions - :ref:`bool` **antialiased** -+----------+------------------------+ -| *Setter* | set_antialiased(value) | -+----------+------------------------+ -| *Getter* | get_antialiased() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_antialiased(value) | ++-----------+------------------------+ +| *Getter* | get_antialiased() | ++-----------+------------------------+ -If ``true``, polygon edges will be anti-aliased. Default value: ``false``. +If ``true``, polygon edges will be anti-aliased. .. _class_Polygon2D_property_bones: - :ref:`Array` **bones** ++-----------+------+ +| *Default* | [ ] | ++-----------+------+ + .. _class_Polygon2D_property_color: - :ref:`Color` **color** -+----------+------------------+ -| *Setter* | set_color(value) | -+----------+------------------+ -| *Getter* | get_color() | -+----------+------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_color(value) | ++-----------+---------------------+ +| *Getter* | get_color() | ++-----------+---------------------+ The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``. @@ -116,45 +124,53 @@ The polygon's fill color. If ``texture`` is defined, it will be multiplied by th - :ref:`int` **internal_vertex_count** -+----------+----------------------------------+ -| *Setter* | set_internal_vertex_count(value) | -+----------+----------------------------------+ -| *Getter* | get_internal_vertex_count() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 0 | ++-----------+----------------------------------+ +| *Setter* | set_internal_vertex_count(value) | ++-----------+----------------------------------+ +| *Getter* | get_internal_vertex_count() | ++-----------+----------------------------------+ .. _class_Polygon2D_property_invert_border: - :ref:`float` **invert_border** -+----------+--------------------------+ -| *Setter* | set_invert_border(value) | -+----------+--------------------------+ -| *Getter* | get_invert_border() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 100.0 | ++-----------+--------------------------+ +| *Setter* | set_invert_border(value) | ++-----------+--------------------------+ +| *Getter* | get_invert_border() | ++-----------+--------------------------+ -Added padding applied to the bounding box when using ``invert``. Setting this value too small may result in a "Bad Polygon" error. Default value: ``100``. +Added padding applied to the bounding box when using ``invert``. Setting this value too small may result in a "Bad Polygon" error. .. _class_Polygon2D_property_invert_enable: - :ref:`bool` **invert_enable** -+----------+-------------------+ -| *Setter* | set_invert(value) | -+----------+-------------------+ -| *Getter* | get_invert() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_invert(value) | ++-----------+-------------------+ +| *Getter* | get_invert() | ++-----------+-------------------+ -If ``true``, polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``. +If ``true``, polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. .. _class_Polygon2D_property_offset: - :ref:`Vector2` **offset** -+----------+-------------------+ -| *Setter* | set_offset(value) | -+----------+-------------------+ -| *Getter* | get_offset() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------+ +| *Setter* | set_offset(value) | ++-----------+-------------------+ +| *Getter* | get_offset() | ++-----------+-------------------+ The offset applied to each vertex. @@ -162,11 +178,13 @@ The offset applied to each vertex. - :ref:`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. @@ -176,31 +194,37 @@ The polygon's list of vertices. The final point will be connected to the first. - :ref:`Array` **polygons** -+----------+---------------------+ -| *Setter* | set_polygons(value) | -+----------+---------------------+ -| *Getter* | get_polygons() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | [ ] | ++-----------+---------------------+ +| *Setter* | set_polygons(value) | ++-----------+---------------------+ +| *Getter* | get_polygons() | ++-----------+---------------------+ .. _class_Polygon2D_property_skeleton: - :ref:`NodePath` **skeleton** -+----------+---------------------+ -| *Setter* | set_skeleton(value) | -+----------+---------------------+ -| *Getter* | get_skeleton() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | NodePath("") | ++-----------+---------------------+ +| *Setter* | set_skeleton(value) | ++-----------+---------------------+ +| *Getter* | get_skeleton() | ++-----------+---------------------+ .. _class_Polygon2D_property_texture: - :ref:`Texture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ The polygon's fill texture. Use ``uv`` to set texture coordinates. @@ -208,11 +232,13 @@ The polygon's fill texture. Use ``uv`` to set texture coordinates. - :ref:`Vector2` **texture_offset** -+----------+---------------------------+ -| *Setter* | set_texture_offset(value) | -+----------+---------------------------+ -| *Getter* | get_texture_offset() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------------+ +| *Setter* | set_texture_offset(value) | ++-----------+---------------------------+ +| *Getter* | get_texture_offset() | ++-----------+---------------------------+ Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin (its top-left corner) will be placed at the polygon's ``position``. @@ -232,11 +258,13 @@ The texture's rotation in radians. - :ref:`float` **texture_rotation_degrees** -+----------+-------------------------------------+ -| *Setter* | set_texture_rotation_degrees(value) | -+----------+-------------------------------------+ -| *Getter* | get_texture_rotation_degrees() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------------+ +| *Setter* | set_texture_rotation_degrees(value) | ++-----------+-------------------------------------+ +| *Getter* | get_texture_rotation_degrees() | ++-----------+-------------------------------------+ The texture's rotation in degrees. @@ -244,11 +272,13 @@ The texture's rotation in degrees. - :ref:`Vector2` **texture_scale** -+----------+--------------------------+ -| *Setter* | set_texture_scale(value) | -+----------+--------------------------+ -| *Getter* | get_texture_scale() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Vector2( 1, 1 ) | ++-----------+--------------------------+ +| *Setter* | set_texture_scale(value) | ++-----------+--------------------------+ +| *Getter* | get_texture_scale() | ++-----------+--------------------------+ Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. @@ -256,11 +286,13 @@ Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger value - :ref:`PoolVector2Array` **uv** -+----------+---------------+ -| *Setter* | set_uv(value) | -+----------+---------------+ -| *Getter* | get_uv() | -+----------+---------------+ ++-----------+----------------------+ +| *Default* | PoolVector2Array( ) | ++-----------+----------------------+ +| *Setter* | set_uv(value) | ++-----------+----------------------+ +| *Getter* | get_uv() | ++-----------+----------------------+ Texture coordinates for each vertex of the polygon. There should be one ``uv`` per polygon vertex. If there are fewer, undefined vertices will use ``(0, 0)``. @@ -268,11 +300,13 @@ Texture coordinates for each vertex of the polygon. There should be one ``uv`` p - :ref:`PoolColorArray` **vertex_colors** -+----------+--------------------------+ -| *Setter* | set_vertex_colors(value) | -+----------+--------------------------+ -| *Getter* | get_vertex_colors() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | PoolColorArray( ) | ++-----------+--------------------------+ +| *Setter* | set_vertex_colors(value) | ++-----------+--------------------------+ +| *Getter* | get_vertex_colors() | ++-----------+--------------------------+ Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use ``color``. diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 82b80d18b..147f92603 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -21,9 +21,9 @@ Base container control for popups and dialogs. Properties ---------- -+-------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`popup_exclusive` | -+-------------------------+--------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`popup_exclusive` | false | ++-------------------------+--------------------------------------------------------------+-------+ Methods ------- @@ -78,11 +78,13 @@ Property Descriptions - :ref:`bool` **popup_exclusive** -+----------+----------------------+ -| *Setter* | set_exclusive(value) | -+----------+----------------------+ -| *Getter* | is_exclusive() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_exclusive(value) | ++-----------+----------------------+ +| *Getter* | is_exclusive() | ++-----------+----------------------+ If ``true``, the popup will not be hidden when a click event occurs outside of it, or when it receives the ``ui_cancel`` action event. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 31b405cff..194feac88 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -19,17 +19,17 @@ PopupMenu displays a list of options. Properties ---------- -+---------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_search` | -+---------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_on_checkable_item_selection` | -+---------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_on_item_selection` | -+---------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_on_state_item_selection` | -+---------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`submenu_popup_delay` | -+---------------------------+----------------------------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`allow_search` | false | ++---------------------------+----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`hide_on_checkable_item_selection` | true | ++---------------------------+----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`hide_on_item_selection` | true | ++---------------------------+----------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`hide_on_state_item_selection` | false | ++---------------------------+----------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`submenu_popup_delay` | 0.3 | ++---------------------------+----------------------------------------------------------------------------------------------------+-------+ Methods ------- @@ -137,43 +137,43 @@ Methods Theme Properties ---------------- -+---------------------------------+-------------------------+ -| :ref:`Texture` | checked | -+---------------------------------+-------------------------+ -| :ref:`Font` | font | -+---------------------------------+-------------------------+ -| :ref:`Color` | font_color | -+---------------------------------+-------------------------+ -| :ref:`Color` | font_color_accel | -+---------------------------------+-------------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+-------------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+-------------------------+ -| :ref:`StyleBox` | hover | -+---------------------------------+-------------------------+ -| :ref:`int` | hseparation | -+---------------------------------+-------------------------+ -| :ref:`StyleBox` | labeled_separator_left | -+---------------------------------+-------------------------+ -| :ref:`StyleBox` | labeled_separator_right | -+---------------------------------+-------------------------+ -| :ref:`StyleBox` | panel | -+---------------------------------+-------------------------+ -| :ref:`StyleBox` | panel_disabled | -+---------------------------------+-------------------------+ -| :ref:`Texture` | radio_checked | -+---------------------------------+-------------------------+ -| :ref:`Texture` | radio_unchecked | -+---------------------------------+-------------------------+ -| :ref:`StyleBox` | separator | -+---------------------------------+-------------------------+ -| :ref:`Texture` | submenu | -+---------------------------------+-------------------------+ -| :ref:`Texture` | unchecked | -+---------------------------------+-------------------------+ -| :ref:`int` | vseparation | -+---------------------------------+-------------------------+ ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Texture` | checked | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Color` | font_color_accel | Color( 0.7, 0.7, 0.7, 0.8 ) | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.4, 0.4, 0.4, 0.8 ) | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`StyleBox` | hover | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`int` | hseparation | 4 | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`StyleBox` | labeled_separator_left | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`StyleBox` | labeled_separator_right | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`StyleBox` | panel | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`StyleBox` | panel_disabled | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Texture` | radio_checked | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Texture` | radio_unchecked | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`StyleBox` | separator | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Texture` | submenu | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`Texture` | unchecked | | ++---------------------------------+-------------------------+------------------------------------------+ +| :ref:`int` | vseparation | 4 | ++---------------------------------+-------------------------+------------------------------------------+ Signals ------- @@ -208,23 +208,27 @@ Property Descriptions - :ref:`bool` **allow_search** -+----------+-------------------------+ -| *Setter* | set_allow_search(value) | -+----------+-------------------------+ -| *Getter* | get_allow_search() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_allow_search(value) | ++-----------+-------------------------+ +| *Getter* | get_allow_search() | ++-----------+-------------------------+ -If ``true``, allows to navigate ``PopupMenu`` with letter keys. Default value: ``false``. +If ``true``, allows to navigate ``PopupMenu`` with letter keys. .. _class_PopupMenu_property_hide_on_checkable_item_selection: - :ref:`bool` **hide_on_checkable_item_selection** -+----------+---------------------------------------------+ -| *Setter* | set_hide_on_checkable_item_selection(value) | -+----------+---------------------------------------------+ -| *Getter* | is_hide_on_checkable_item_selection() | -+----------+---------------------------------------------+ ++-----------+---------------------------------------------+ +| *Default* | true | ++-----------+---------------------------------------------+ +| *Setter* | set_hide_on_checkable_item_selection(value) | ++-----------+---------------------------------------------+ +| *Getter* | is_hide_on_checkable_item_selection() | ++-----------+---------------------------------------------+ If ``true``, hides the ``PopupMenu`` when a checkbox or radio button is selected. @@ -232,11 +236,13 @@ If ``true``, hides the ``PopupMenu`` when a checkbox or radio button is selected - :ref:`bool` **hide_on_item_selection** -+----------+-----------------------------------+ -| *Setter* | set_hide_on_item_selection(value) | -+----------+-----------------------------------+ -| *Getter* | is_hide_on_item_selection() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | true | ++-----------+-----------------------------------+ +| *Setter* | set_hide_on_item_selection(value) | ++-----------+-----------------------------------+ +| *Getter* | is_hide_on_item_selection() | ++-----------+-----------------------------------+ If ``true``, hides the ``PopupMenu`` when an item is selected. @@ -244,11 +250,13 @@ If ``true``, hides the ``PopupMenu`` when an item is selected. - :ref:`bool` **hide_on_state_item_selection** -+----------+-----------------------------------------+ -| *Setter* | set_hide_on_state_item_selection(value) | -+----------+-----------------------------------------+ -| *Getter* | is_hide_on_state_item_selection() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | false | ++-----------+-----------------------------------------+ +| *Setter* | set_hide_on_state_item_selection(value) | ++-----------+-----------------------------------------+ +| *Getter* | is_hide_on_state_item_selection() | ++-----------+-----------------------------------------+ If ``true``, hides the ``PopupMenu`` when a state item is selected. @@ -256,13 +264,15 @@ If ``true``, hides the ``PopupMenu`` when a state item is selected. - :ref:`float` **submenu_popup_delay** -+----------+--------------------------------+ -| *Setter* | set_submenu_popup_delay(value) | -+----------+--------------------------------+ -| *Getter* | get_submenu_popup_delay() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.3 | ++-----------+--------------------------------+ +| *Setter* | set_submenu_popup_delay(value) | ++-----------+--------------------------------+ +| *Getter* | get_submenu_popup_delay() | ++-----------+--------------------------------+ -Sets the delay time for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. Default value: ``0.3`` seconds. +Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. Method Descriptions ------------------- diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 84798fde5..a4deb3dd7 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -21,13 +21,13 @@ Base class for all primitive meshes. Handles applying a :ref:`Material` | :ref:`custom_aabb` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_faces` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+--------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------+--------------------------+ +| :ref:`AABB` | :ref:`custom_aabb` | AABB( 0, 0, 0, 0, 0, 0 ) | ++---------------------------------+--------------------------------------------------------------+--------------------------+ +| :ref:`bool` | :ref:`flip_faces` | false | ++---------------------------------+--------------------------------------------------------------+--------------------------+ +| :ref:`Material` | :ref:`material` | null | ++---------------------------------+--------------------------------------------------------------+--------------------------+ Methods ------- @@ -48,11 +48,13 @@ Property Descriptions - :ref:`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` with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices. @@ -60,23 +62,27 @@ Overrides the :ref:`AABB` with one defined by user for use with frus - :ref:`bool` **flip_faces** -+----------+-----------------------+ -| *Setter* | set_flip_faces(value) | -+----------+-----------------------+ -| *Getter* | get_flip_faces() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | false | ++-----------+-----------------------+ +| *Setter* | set_flip_faces(value) | ++-----------+-----------------------+ +| *Getter* | get_flip_faces() | ++-----------+-----------------------+ -If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. Result is the same as using \*CULL_BACK\* in :ref:`SpatialMaterial`. Default is false. +If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. Result is the same as using \*CULL_BACK\* in :ref:`SpatialMaterial`. .. _class_PrimitiveMesh_property_material: - :ref:`Material` **material** -+----------+---------------------+ -| *Setter* | set_material(value) | -+----------+---------------------+ -| *Getter* | get_material() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_material(value) | ++-----------+---------------------+ +| *Getter* | get_material() | ++-----------+---------------------+ The current :ref:`Material` of the primitive mesh. diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index b299c65b9..673a972f8 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -19,17 +19,17 @@ Class representing a prism-shaped :ref:`PrimitiveMesh`. Properties ---------- -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`left_to_right` | -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`size` | -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_depth` | -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_height` | -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_width` | -+-------------------------------+--------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`left_to_right` | 0.5 | ++-------------------------------+--------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`size` | Vector3( 2, 2, 2 ) | ++-------------------------------+--------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`subdivide_depth` | 0 | ++-------------------------------+--------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`subdivide_height` | 0 | ++-------------------------------+--------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`subdivide_width` | 0 | ++-------------------------------+--------------------------------------------------------------------+--------------------+ Description ----------- @@ -43,59 +43,69 @@ Property Descriptions - :ref:`float` **left_to_right** -+----------+--------------------------+ -| *Setter* | set_left_to_right(value) | -+----------+--------------------------+ -| *Getter* | get_left_to_right() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.5 | ++-----------+--------------------------+ +| *Setter* | set_left_to_right(value) | ++-----------+--------------------------+ +| *Getter* | get_left_to_right() | ++-----------+--------------------------+ -Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. Defaults to 0.5 (positioned on the midpoint). +Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. .. _class_PrismMesh_property_size: - :ref:`Vector3` **size** -+----------+-----------------+ -| *Setter* | set_size(value) | -+----------+-----------------+ -| *Getter* | get_size() | -+----------+-----------------+ ++-----------+--------------------+ +| *Default* | Vector3( 2, 2, 2 ) | ++-----------+--------------------+ +| *Setter* | set_size(value) | ++-----------+--------------------+ +| *Getter* | get_size() | ++-----------+--------------------+ -Size of the prism. Defaults to (2.0, 2.0, 2.0). +Size of the prism. .. _class_PrismMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** -+----------+----------------------------+ -| *Setter* | set_subdivide_depth(value) | -+----------+----------------------------+ -| *Getter* | get_subdivide_depth() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_subdivide_depth(value) | ++-----------+----------------------------+ +| *Getter* | get_subdivide_depth() | ++-----------+----------------------------+ -Number of added edge loops along the Z axis. Defaults to 0. +Number of added edge loops along the Z axis. .. _class_PrismMesh_property_subdivide_height: - :ref:`int` **subdivide_height** -+----------+-----------------------------+ -| *Setter* | set_subdivide_height(value) | -+----------+-----------------------------+ -| *Getter* | get_subdivide_height() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0 | ++-----------+-----------------------------+ +| *Setter* | set_subdivide_height(value) | ++-----------+-----------------------------+ +| *Getter* | get_subdivide_height() | ++-----------+-----------------------------+ -Number of added edge loops along the Y axis. Defaults to 0. +Number of added edge loops along the Y axis. .. _class_PrismMesh_property_subdivide_width: - :ref:`int` **subdivide_width** -+----------+----------------------------+ -| *Setter* | set_subdivide_width(value) | -+----------+----------------------------+ -| *Getter* | get_subdivide_width() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_subdivide_width(value) | ++-----------+----------------------------+ +| *Getter* | get_subdivide_width() | ++-----------+----------------------------+ -Number of added edge loops along the X axis. Defaults to 0. +Number of added edge loops along the X axis. diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index f3770afc6..df9d592f3 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -19,39 +19,39 @@ Type of :ref:`Sky` that is generated procedurally based on user input Properties ---------- -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ground_bottom_color` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ground_curve` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ground_energy` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ground_horizon_color` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sky_curve` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sky_energy` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`sky_horizon_color` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`sky_top_color` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_angle_max` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_angle_min` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`sun_color` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_curve` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_energy` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_latitude` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_longitude` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`TextureSize` | :ref:`texture_size` | -+----------------------------------------------------+--------------------------------------------------------------------------------+ ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`Color` | :ref:`ground_bottom_color` | Color( 0.156863, 0.184314, 0.211765, 1 ) | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`ground_curve` | 0.02 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`ground_energy` | 1.0 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`Color` | :ref:`ground_horizon_color` | Color( 0.423529, 0.396078, 0.372549, 1 ) | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`sky_curve` | 0.09 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`sky_energy` | 1.0 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`Color` | :ref:`sky_horizon_color` | Color( 0.839216, 0.917647, 0.980392, 1 ) | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`Color` | :ref:`sky_top_color` | Color( 0.647059, 0.839216, 0.945098, 1 ) | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`sun_angle_max` | 100.0 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`sun_angle_min` | 1.0 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`Color` | :ref:`sun_color` | Color( 1, 1, 1, 1 ) | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`sun_curve` | 0.05 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`sun_energy` | 1.0 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`sun_latitude` | 35.0 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`float` | :ref:`sun_longitude` | 0.0 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ +| :ref:`TextureSize` | :ref:`texture_size` | 2 | ++----------------------------------------------------+--------------------------------------------------------------------------------+------------------------------------------+ Enumerations ------------ @@ -98,11 +98,13 @@ Property Descriptions - :ref:`Color` **ground_bottom_color** -+----------+--------------------------------+ -| *Setter* | set_ground_bottom_color(value) | -+----------+--------------------------------+ -| *Getter* | get_ground_bottom_color() | -+----------+--------------------------------+ ++-----------+------------------------------------------+ +| *Default* | Color( 0.156863, 0.184314, 0.211765, 1 ) | ++-----------+------------------------------------------+ +| *Setter* | set_ground_bottom_color(value) | ++-----------+------------------------------------------+ +| *Getter* | get_ground_bottom_color() | ++-----------+------------------------------------------+ Color of the ground at the bottom. @@ -110,11 +112,13 @@ Color of the ground at the bottom. - :ref:`float` **ground_curve** -+----------+-------------------------+ -| *Setter* | set_ground_curve(value) | -+----------+-------------------------+ -| *Getter* | get_ground_curve() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0.02 | ++-----------+-------------------------+ +| *Setter* | set_ground_curve(value) | ++-----------+-------------------------+ +| *Getter* | get_ground_curve() | ++-----------+-------------------------+ How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. @@ -122,11 +126,13 @@ How quickly the :ref:`ground_horizon_color` **ground_energy** -+----------+--------------------------+ -| *Setter* | set_ground_energy(value) | -+----------+--------------------------+ -| *Getter* | get_ground_energy() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_ground_energy(value) | ++-----------+--------------------------+ +| *Getter* | get_ground_energy() | ++-----------+--------------------------+ Amount of energy contribution from the ground. @@ -134,11 +140,13 @@ Amount of energy contribution from the ground. - :ref:`Color` **ground_horizon_color** -+----------+---------------------------------+ -| *Setter* | set_ground_horizon_color(value) | -+----------+---------------------------------+ -| *Getter* | get_ground_horizon_color() | -+----------+---------------------------------+ ++-----------+------------------------------------------+ +| *Default* | Color( 0.423529, 0.396078, 0.372549, 1 ) | ++-----------+------------------------------------------+ +| *Setter* | set_ground_horizon_color(value) | ++-----------+------------------------------------------+ +| *Getter* | get_ground_horizon_color() | ++-----------+------------------------------------------+ Color of the ground at the horizon. @@ -146,11 +154,13 @@ Color of the ground at the horizon. - :ref:`float` **sky_curve** -+----------+----------------------+ -| *Setter* | set_sky_curve(value) | -+----------+----------------------+ -| *Getter* | get_sky_curve() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0.09 | ++-----------+----------------------+ +| *Setter* | set_sky_curve(value) | ++-----------+----------------------+ +| *Getter* | get_sky_curve() | ++-----------+----------------------+ How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. @@ -158,11 +168,13 @@ How quickly the :ref:`sky_horizon_color` **sky_energy** -+----------+-----------------------+ -| *Setter* | set_sky_energy(value) | -+----------+-----------------------+ -| *Getter* | get_sky_energy() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_sky_energy(value) | ++-----------+-----------------------+ +| *Getter* | get_sky_energy() | ++-----------+-----------------------+ Amount of energy contribution from the sky. @@ -170,11 +182,13 @@ Amount of energy contribution from the sky. - :ref:`Color` **sky_horizon_color** -+----------+------------------------------+ -| *Setter* | set_sky_horizon_color(value) | -+----------+------------------------------+ -| *Getter* | get_sky_horizon_color() | -+----------+------------------------------+ ++-----------+------------------------------------------+ +| *Default* | Color( 0.839216, 0.917647, 0.980392, 1 ) | ++-----------+------------------------------------------+ +| *Setter* | set_sky_horizon_color(value) | ++-----------+------------------------------------------+ +| *Getter* | get_sky_horizon_color() | ++-----------+------------------------------------------+ Color of the sky at the horizon. @@ -182,11 +196,13 @@ Color of the sky at the horizon. - :ref:`Color` **sky_top_color** -+----------+--------------------------+ -| *Setter* | set_sky_top_color(value) | -+----------+--------------------------+ -| *Getter* | get_sky_top_color() | -+----------+--------------------------+ ++-----------+------------------------------------------+ +| *Default* | Color( 0.647059, 0.839216, 0.945098, 1 ) | ++-----------+------------------------------------------+ +| *Setter* | set_sky_top_color(value) | ++-----------+------------------------------------------+ +| *Getter* | get_sky_top_color() | ++-----------+------------------------------------------+ Color of the sky at the top. @@ -194,11 +210,13 @@ Color of the sky at the top. - :ref:`float` **sun_angle_max** -+----------+--------------------------+ -| *Setter* | set_sun_angle_max(value) | -+----------+--------------------------+ -| *Getter* | get_sun_angle_max() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 100.0 | ++-----------+--------------------------+ +| *Setter* | set_sun_angle_max(value) | ++-----------+--------------------------+ +| *Getter* | get_sun_angle_max() | ++-----------+--------------------------+ Distance from center of sun where it fades out completely. @@ -206,11 +224,13 @@ Distance from center of sun where it fades out completely. - :ref:`float` **sun_angle_min** -+----------+--------------------------+ -| *Setter* | set_sun_angle_min(value) | -+----------+--------------------------+ -| *Getter* | get_sun_angle_min() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_sun_angle_min(value) | ++-----------+--------------------------+ +| *Getter* | get_sun_angle_min() | ++-----------+--------------------------+ Distance from sun where it goes from solid to starting to fade. @@ -218,11 +238,13 @@ Distance from sun where it goes from solid to starting to fade. - :ref:`Color` **sun_color** -+----------+----------------------+ -| *Setter* | set_sun_color(value) | -+----------+----------------------+ -| *Getter* | get_sun_color() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+----------------------+ +| *Setter* | set_sun_color(value) | ++-----------+----------------------+ +| *Getter* | get_sun_color() | ++-----------+----------------------+ The sun's color. @@ -230,11 +252,13 @@ The sun's color. - :ref:`float` **sun_curve** -+----------+----------------------+ -| *Setter* | set_sun_curve(value) | -+----------+----------------------+ -| *Getter* | get_sun_curve() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0.05 | ++-----------+----------------------+ +| *Setter* | set_sun_curve(value) | ++-----------+----------------------+ +| *Getter* | get_sun_curve() | ++-----------+----------------------+ How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max`. @@ -242,11 +266,13 @@ How quickly the sun fades away between :ref:`sun_angle_min` **sun_energy** -+----------+-----------------------+ -| *Setter* | set_sun_energy(value) | -+----------+-----------------------+ -| *Getter* | get_sun_energy() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_sun_energy(value) | ++-----------+-----------------------+ +| *Getter* | get_sun_energy() | ++-----------+-----------------------+ Amount of energy contribution from the sun. @@ -254,11 +280,13 @@ Amount of energy contribution from the sun. - :ref:`float` **sun_latitude** -+----------+-------------------------+ -| *Setter* | set_sun_latitude(value) | -+----------+-------------------------+ -| *Getter* | get_sun_latitude() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 35.0 | ++-----------+-------------------------+ +| *Setter* | set_sun_latitude(value) | ++-----------+-------------------------+ +| *Getter* | get_sun_latitude() | ++-----------+-------------------------+ The sun's height using polar coordinates. @@ -266,11 +294,13 @@ The sun's height using polar coordinates. - :ref:`float` **sun_longitude** -+----------+--------------------------+ -| *Setter* | set_sun_longitude(value) | -+----------+--------------------------+ -| *Getter* | get_sun_longitude() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------+ +| *Setter* | set_sun_longitude(value) | ++-----------+--------------------------+ +| *Getter* | get_sun_longitude() | ++-----------+--------------------------+ The direction of the sun using polar coordinates. @@ -278,11 +308,13 @@ The direction of the sun using polar coordinates. - :ref:`TextureSize` **texture_size** -+----------+-------------------------+ -| *Setter* | set_texture_size(value) | -+----------+-------------------------+ -| *Getter* | get_texture_size() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 2 | ++-----------+-------------------------+ +| *Setter* | set_texture_size(value) | ++-----------+-------------------------+ +| *Getter* | get_texture_size() | ++-----------+-------------------------+ Size of :ref:`Texture` that the ProceduralSky will generate. The size is set using :ref:`TextureSize`. diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 95a4fa22d..0d426221e 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -19,24 +19,24 @@ General-purpose progress bar. Properties ---------- -+-------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`percent_visible` | -+-------------------------+--------------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`percent_visible` | true | ++-------------------------+--------------------------------------------------------------------+------+ Theme Properties ---------------- -+---------------------------------+-------------------+ -| :ref:`StyleBox` | bg | -+---------------------------------+-------------------+ -| :ref:`StyleBox` | fg | -+---------------------------------+-------------------+ -| :ref:`Font` | font | -+---------------------------------+-------------------+ -| :ref:`Color` | font_color | -+---------------------------------+-------------------+ -| :ref:`Color` | font_color_shadow | -+---------------------------------+-------------------+ ++---------------------------------+-------------------+------------------------------------------+ +| :ref:`StyleBox` | bg | | ++---------------------------------+-------------------+------------------------------------------+ +| :ref:`StyleBox` | fg | | ++---------------------------------+-------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+-------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+-------------------+------------------------------------------+ +| :ref:`Color` | font_color_shadow | Color( 0, 0, 0, 1 ) | ++---------------------------------+-------------------+------------------------------------------+ Description ----------- @@ -50,11 +50,13 @@ Property Descriptions - :ref:`bool` **percent_visible** -+----------+----------------------------+ -| *Setter* | set_percent_visible(value) | -+----------+----------------------------+ -| *Getter* | is_percent_visible() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | true | ++-----------+----------------------------+ +| *Setter* | set_percent_visible(value) | ++-----------+----------------------------+ +| *Getter* | is_percent_visible() | ++-----------+----------------------------+ -If ``true``, the fill percentage is displayed on the bar. Default value: ``true``. +If ``true``, the fill percentage is displayed on the bar. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 438e70a95..2039a59af 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -19,539 +19,543 @@ Contains global variables accessible from everywhere. Properties ---------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`android/modules` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`application/boot_splash/bg_color` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/fullsize` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/boot_splash/image` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/use_filter` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/custom_user_dir_name` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/icon` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/macos_native_icon` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/name` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/project_settings_override` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/config/use_custom_user_dir` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/windows_native_icon` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stderr` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stdout` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/run/frame_delay_msec` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/low_processor_mode` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/run/main_scene` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/channel_disable_threshold_db` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/channel_disable_time` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio/default_bus_layout` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio/driver` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio/enable_audio_input` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/mix_rate` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/output_latency` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/video_delay_compensation_ms` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/gzip/compression_level` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zlib/compression_level` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zstd/compression_level` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/completion/autocomplete_setters_and_getters` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/constant_used_as_function` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/deprecated_keyword` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_may_yield` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_used_as_property` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/incompatible_ternary` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/integer_division` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/narrowing_conversion` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/property_used_as_function` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/shadowed_variable` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unreachable_code` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_cast` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_method_access` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_property_access` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_argument` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_class_variable` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_signal` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_variable` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/variable_conflicts_function` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/void_assignment` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`debug/settings/crash_handler/message` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/fps/force_fps` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/profiler/max_functions` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/visual_script/max_call_stack` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`display/mouse_cursor/custom_image` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`display/mouse_cursor/tooltip_position_offset` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`display/window/handheld/orientation` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/per_pixel_transparency/allowed` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/per_pixel_transparency/enabled` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/always_on_top` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/borderless` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/fullscreen` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/height` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/resizable` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/test_height` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/test_width` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/width` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/vsync/use_vsync` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor/active` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`editor/search_in_file_extensions` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`gui/theme/custom` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`gui/theme/custom_font` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/theme/use_hidpi` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_accept` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_cancel` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_down` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_end` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_focus_next` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_focus_prev` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_home` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_left` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_page_down` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_page_up` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_right` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_select` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_up` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_1` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_10` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_11` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_12` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_13` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_14` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_15` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_16` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_17` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_18` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_19` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_2` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_20` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_3` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_4` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_5` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_6` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_7` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_8` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_9` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_1` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_10` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_11` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_12` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_13` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_14` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_15` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_16` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_17` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_18` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_19` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_2` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_20` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_3` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_4` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_5` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_6` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_7` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_8` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_9` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`locale/fallback` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`locale/test` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`logging/file_logging/enable_file_logging` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`logging/file_logging/log_path` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`logging/file_logging/max_log_files` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_errors_per_frame` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_messages_per_frame` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_in_buffer_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_in_packets` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_out_buffer_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_out_packets` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_in_buffer_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_in_packets` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_out_buffer_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_out_packets` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/remote_fs/page_size` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node/name_casing` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node/name_num_separator` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`physics/2d/physics_engine` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/2d/thread_model` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/3d/active_soft_world` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`physics/3d/physics_engine` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/common/physics_fps` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`rendering/environment/default_clear_color` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/blend_shape_max_buffer_size_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_buffer_size_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_index_buffer_size_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/immediate_buffer_size_kb` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/2d/use_pixel_snap` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/quality/depth_prepass/disable_for_vendors` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/depth_prepass/enable` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/directional_shadow/size` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/directional_shadow/size.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/quality/driver/driver_name` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/driver/fallback_to_gles2` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/filters/anisotropic_filter_level` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_0_subdiv` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_1_subdiv` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_2_subdiv` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_3_subdiv` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode.mobile` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/follow_surface` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/quality` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/scale` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/weight_samples` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/voxel_cone_tracing/high_quality` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/threads/thread_model` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_bptc` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_etc` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_etc2` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_pvrtc` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_s3tc` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`script` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`android/modules` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`application/boot_splash/bg_color` | Color( 0.137255, 0.137255, 0.137255, 1 ) | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/fullsize` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/boot_splash/image` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/use_filter` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/custom_user_dir_name` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/icon` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/macos_native_icon` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/name` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/project_settings_override` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/config/use_custom_user_dir` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/windows_native_icon` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stderr` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stdout` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/run/frame_delay_msec` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/low_processor_mode` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | 6900 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/run/main_scene` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/channel_disable_threshold_db` | -60.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/channel_disable_time` | 2.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio/default_bus_layout` | "res://default_bus_layout.tres" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio/driver` | "PulseAudio" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio/enable_audio_input` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/mix_rate` | 44100 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/output_latency` | 15 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/video_delay_compensation_ms` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/gzip/compression_level` | -1 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zlib/compression_level` | -1 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zstd/compression_level` | 3 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | 27 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/completion/autocomplete_setters_and_getters` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/constant_used_as_function` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/deprecated_keyword` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_may_yield` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_used_as_property` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/incompatible_ternary` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/integer_division` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/narrowing_conversion` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/property_used_as_function` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/shadowed_variable` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unreachable_code` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_cast` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_method_access` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_property_access` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_argument` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_class_variable` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_signal` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_variable` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/variable_conflicts_function` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/void_assignment` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`debug/settings/crash_handler/message` | "Please include this when reporting the bug on https://github.com/godotengine/godot/issues" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/fps/force_fps` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | 1024 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/profiler/max_functions` | 16384 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/visual_script/max_call_stack` | 1024 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`display/mouse_cursor/custom_image` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | Vector2( 0, 0 ) | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`display/mouse_cursor/tooltip_position_offset` | Vector2( 10, 10 ) | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`display/window/handheld/orientation` | "landscape" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/per_pixel_transparency/allowed` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/per_pixel_transparency/enabled` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/always_on_top` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/borderless` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/fullscreen` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/height` | 600 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/resizable` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/test_height` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/test_width` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/width` | 1024 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/vsync/use_vsync` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor/active` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`editor/search_in_file_extensions` | PoolStringArray( "gd", "shader" ) | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`gui/theme/custom` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`gui/theme/custom_font` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/theme/use_hidpi` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | 2000 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | 3 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_accept` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777221,"unicode":0,"echo":false,"script":null) , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777222,"unicode":0,"echo":false,"script":null) , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":32,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":0,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_cancel` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777217,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":1,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_down` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777234,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":13,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_end` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777230,"unicode":0,"echo":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_focus_next` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777218,"unicode":0,"echo":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_focus_prev` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":true,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777218,"unicode":0,"echo":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_home` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777229,"unicode":0,"echo":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_left` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777231,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":14,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_page_down` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777236,"unicode":0,"echo":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_page_up` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777235,"unicode":0,"echo":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_right` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777233,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":15,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_select` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":32,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":3,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_up` | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777232,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":12,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_1` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_10` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_11` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_12` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_13` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_14` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_15` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_16` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_17` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_18` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_19` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_2` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_20` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_3` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_4` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_5` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_6` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_7` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_8` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_9` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_1` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_10` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_11` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_12` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_13` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_14` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_15` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_16` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_17` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_18` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_19` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_2` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_20` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_3` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_4` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_5` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_6` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_7` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_8` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_9` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`locale/fallback` | "en" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`locale/test` | "" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`logging/file_logging/enable_file_logging` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`logging/file_logging/log_path` | "user://logs/log.txt" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`logging/file_logging/max_log_files` | 10 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | 1024 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | 60 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | 2048 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_errors_per_frame` | 10 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_messages_per_frame` | 10 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | 16 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_in_buffer_kb` | 64 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_in_packets` | 1024 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_out_buffer_kb` | 64 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_out_packets` | 1024 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_in_buffer_kb` | 64 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_in_packets` | 1024 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_out_buffer_kb` | 64 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_out_packets` | 1024 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | 4 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_size` | 65536 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node/name_casing` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node/name_num_separator` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/default_gravity` | 98 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`physics/2d/physics_engine` | "DEFAULT" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/thread_model` | 1 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/3d/active_soft_world` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/default_gravity` | 9.8 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`physics/3d/physics_engine` | "DEFAULT" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/common/physics_fps` | 60 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | 0.5 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`rendering/environment/default_clear_color` | Color( 0.3, 0.3, 0.3, 1 ) | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/blend_shape_max_buffer_size_kb` | 4096 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_buffer_size_kb` | 128 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_index_buffer_size_kb` | 128 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/immediate_buffer_size_kb` | 2048 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | 65536 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | 3600 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/2d/use_pixel_snap` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/quality/depth_prepass/disable_for_vendors` | "PowerVR,Mali,Adreno,Apple" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/depth_prepass/enable` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/directional_shadow/size` | 4096 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/directional_shadow/size.mobile` | 2048 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/quality/driver/driver_name` | "GLES3" | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/driver/fallback_to_gles2` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/anisotropic_filter_level` | 4 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | 2 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | 3 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx.mobile` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley.mobile` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading.mobile` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_0_subdiv` | 1 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_1_subdiv` | 2 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_2_subdiv` | 3 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_3_subdiv` | 4 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size` | 4096 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size.mobile` | 2048 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode` | 1 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode.mobile` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/follow_surface` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/quality` | 1 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/scale` | 1.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/weight_samples` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/voxel_cone_tracing/high_quality` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/threads/thread_model` | 1 | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_bptc` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_etc` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_etc2` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_pvrtc` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_s3tc` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`script` | null | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Methods ------- @@ -600,36 +604,60 @@ Property Descriptions - :ref:`String` **android/modules** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + Comma-separated list of custom Android modules (which must have been built in the Android export templates) using their Java package path, e.g. ``org/godotengine/org/GodotPaymentV3,org/godotengine/godot/MyCustomSingleton"``. .. _class_ProjectSettings_property_application/boot_splash/bg_color: - :ref:`Color` **application/boot_splash/bg_color** ++-----------+------------------------------------------+ +| *Default* | Color( 0.137255, 0.137255, 0.137255, 1 ) | ++-----------+------------------------------------------+ + Background color for the boot splash. .. _class_ProjectSettings_property_application/boot_splash/fullsize: - :ref:`bool` **application/boot_splash/fullsize** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, scale the boot splash image to the full window length when engine starts. If ``false``, the engine will leave it at the default pixel size. .. _class_ProjectSettings_property_application/boot_splash/image: - :ref:`String` **application/boot_splash/image** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + Path to an image used as the boot splash. .. _class_ProjectSettings_property_application/boot_splash/use_filter: - :ref:`bool` **application/boot_splash/use_filter** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, applies linear filtering when scaling the image (recommended for high resolution artwork). If ``false``, uses nearest-neighbor interpolation (recommended for pixel art). .. _class_ProjectSettings_property_application/config/custom_user_dir_name: - :ref:`String` **application/config/custom_user_dir_name** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + This user directory is used for storing persistent data (``user://`` filesystem). If left empty, ``user://`` resolves to a project-specific folder in Godot's own configuration folder (see :ref:`OS.get_user_data_dir`). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). The :ref:`application/config/use_custom_user_dir` setting must be enabled for this to take effect. @@ -638,1094 +666,1986 @@ The :ref:`application/config/use_custom_user_dir` **application/config/icon** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + Icon used for the project, set when project loads. Exporters will also use this icon when possible. .. _class_ProjectSettings_property_application/config/macos_native_icon: - :ref:`String` **application/config/macos_native_icon** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_application/config/name: - :ref:`String` **application/config/name** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. .. _class_ProjectSettings_property_application/config/project_settings_override: - :ref:`String` **application/config/project_settings_override** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + Specifies a file to override project settings. For example: ``user://custom_settings.cfg``. .. _class_ProjectSettings_property_application/config/use_custom_user_dir: - :ref:`bool` **application/config/use_custom_user_dir** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, the project will save user data to its own user directory (see :ref:`application/config/custom_user_dir_name`). This setting is only effective on desktop platforms. A name must be set in the :ref:`application/config/custom_user_dir_name` setting for this to take effect. If ``false``, the project will save user data to ``(OS user data directory)/Godot/app_userdata/(project name)``. .. _class_ProjectSettings_property_application/config/windows_native_icon: - :ref:`String` **application/config/windows_native_icon** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_application/run/disable_stderr: - :ref:`bool` **application/run/disable_stderr** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, disables printing to standard error in an exported build. .. _class_ProjectSettings_property_application/run/disable_stdout: - :ref:`bool` **application/run/disable_stdout** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, disables printing to standard output in an exported build. .. _class_ProjectSettings_property_application/run/frame_delay_msec: - :ref:`int` **application/run/frame_delay_msec** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + Forces a delay between frames in the main loop (in milliseconds). This may be useful if you plan to disable vertical synchronization. .. _class_ProjectSettings_property_application/run/low_processor_mode: - :ref:`bool` **application/run/low_processor_mode** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, enables low-processor usage mode. This setting only works on desktop platforms. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) in most games. .. _class_ProjectSettings_property_application/run/low_processor_mode_sleep_usec: - :ref:`int` **application/run/low_processor_mode_sleep_usec** ++-----------+------+ +| *Default* | 6900 | ++-----------+------+ + Amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage. .. _class_ProjectSettings_property_application/run/main_scene: - :ref:`String` **application/run/main_scene** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + Path to the main scene file that will be loaded when the project runs. .. _class_ProjectSettings_property_audio/channel_disable_threshold_db: - :ref:`float` **audio/channel_disable_threshold_db** ++-----------+-------+ +| *Default* | -60.0 | ++-----------+-------+ + Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. .. _class_ProjectSettings_property_audio/channel_disable_time: - :ref:`float` **audio/channel_disable_time** ++-----------+-----+ +| *Default* | 2.0 | ++-----------+-----+ + Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. .. _class_ProjectSettings_property_audio/default_bus_layout: - :ref:`String` **audio/default_bus_layout** ++-----------+---------------------------------+ +| *Default* | "res://default_bus_layout.tres" | ++-----------+---------------------------------+ + .. _class_ProjectSettings_property_audio/driver: - :ref:`String` **audio/driver** ++-----------+--------------+ +| *Default* | "PulseAudio" | ++-----------+--------------+ + Specifies the audio driver to use. This setting is platform-dependent as each platform supports different audio drivers. If left empty, the default audio driver will be used. .. _class_ProjectSettings_property_audio/enable_audio_input: - :ref:`bool` **audio/enable_audio_input** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, microphone input will be allowed. This requires appropriate permissions to be set when exporting to Android or iOS. .. _class_ProjectSettings_property_audio/mix_rate: - :ref:`int` **audio/mix_rate** ++-----------+-------+ +| *Default* | 44100 | ++-----------+-------+ + Mixing rate used for audio. In general, it's better to not touch this and leave it to the host operating system. .. _class_ProjectSettings_property_audio/output_latency: - :ref:`int` **audio/output_latency** ++-----------+----+ +| *Default* | 15 | ++-----------+----+ + Output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. .. _class_ProjectSettings_property_audio/video_delay_compensation_ms: - :ref:`int` **audio/video_delay_compensation_ms** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. .. _class_ProjectSettings_property_compression/formats/gzip/compression_level: - :ref:`int` **compression/formats/gzip/compression_level** ++-----------+----+ +| *Default* | -1 | ++-----------+----+ + Default compression level for gzip. Affects compressed scenes and resources. .. _class_ProjectSettings_property_compression/formats/zlib/compression_level: - :ref:`int` **compression/formats/zlib/compression_level** ++-----------+----+ +| *Default* | -1 | ++-----------+----+ + Default compression level for Zlib. Affects compressed scenes and resources. .. _class_ProjectSettings_property_compression/formats/zstd/compression_level: - :ref:`int` **compression/formats/zstd/compression_level** ++-----------+---+ +| *Default* | 3 | ++-----------+---+ + Default compression level for Zstandard. Affects compressed scenes and resources. .. _class_ProjectSettings_property_compression/formats/zstd/long_distance_matching: - :ref:`bool` **compression/formats/zstd/long_distance_matching** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Enables long-distance matching in Zstandard. .. _class_ProjectSettings_property_compression/formats/zstd/window_log_size: - :ref:`int` **compression/formats/zstd/window_log_size** ++-----------+----+ +| *Default* | 27 | ++-----------+----+ + .. _class_ProjectSettings_property_debug/gdscript/completion/autocomplete_setters_and_getters: - :ref:`bool` **debug/gdscript/completion/autocomplete_setters_and_getters** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards. .. _class_ProjectSettings_property_debug/gdscript/warnings/constant_used_as_function: - :ref:`bool` **debug/gdscript/warnings/constant_used_as_function** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a constant is used as a function. .. _class_ProjectSettings_property_debug/gdscript/warnings/deprecated_keyword: - :ref:`bool` **debug/gdscript/warnings/deprecated_keyword** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when deprecated keywords such as ``slave`` are used. .. _class_ProjectSettings_property_debug/gdscript/warnings/enable: - :ref:`bool` **debug/gdscript/warnings/enable** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables specific GDScript warnings (see ``debug/gdscript/warnings/*`` settings). If ``false``, disables all GDScript warnings. .. _class_ProjectSettings_property_debug/gdscript/warnings/function_conflicts_constant: - :ref:`bool` **debug/gdscript/warnings/function_conflicts_constant** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a function is declared with the same name as a constant. .. _class_ProjectSettings_property_debug/gdscript/warnings/function_conflicts_variable: - :ref:`bool` **debug/gdscript/warnings/function_conflicts_variable** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a function is declared with the same name as a variable. This will turn into an error in a future version when first-class functions become supported in GDScript. .. _class_ProjectSettings_property_debug/gdscript/warnings/function_may_yield: - :ref:`bool` **debug/gdscript/warnings/function_may_yield** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a function assigned to a variable may yield and return a function state instead of a value. .. _class_ProjectSettings_property_debug/gdscript/warnings/function_used_as_property: - :ref:`bool` **debug/gdscript/warnings/function_used_as_property** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when using a function as if it was a property. .. _class_ProjectSettings_property_debug/gdscript/warnings/incompatible_ternary: - :ref:`bool` **debug/gdscript/warnings/incompatible_ternary** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a ternary operator may emit values with incompatible types. .. _class_ProjectSettings_property_debug/gdscript/warnings/integer_division: - :ref:`bool` **debug/gdscript/warnings/integer_division** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when dividing an integer by another integer (the decimal part will be discarded). .. _class_ProjectSettings_property_debug/gdscript/warnings/narrowing_conversion: - :ref:`bool` **debug/gdscript/warnings/narrowing_conversion** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when passing a floating-point value to a function that expects an integer (it will be converted and lose precision). .. _class_ProjectSettings_property_debug/gdscript/warnings/property_used_as_function: - :ref:`bool` **debug/gdscript/warnings/property_used_as_function** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when using a property as if it was a function. .. _class_ProjectSettings_property_debug/gdscript/warnings/return_value_discarded: - :ref:`bool` **debug/gdscript/warnings/return_value_discarded** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the :ref:`Error` enum. .. _class_ProjectSettings_property_debug/gdscript/warnings/shadowed_variable: - :ref:`bool` **debug/gdscript/warnings/shadowed_variable** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when defining a local or subclass member variable that would shadow a variable at an upper level (such as a member variable). .. _class_ProjectSettings_property_debug/gdscript/warnings/standalone_expression: - :ref:`bool` **debug/gdscript/warnings/standalone_expression** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when calling an expression that has no effect on the surrounding code, such as writing ``2 + 2`` as a statement. .. _class_ProjectSettings_property_debug/gdscript/warnings/treat_warnings_as_errors: - :ref:`bool` **debug/gdscript/warnings/treat_warnings_as_errors** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, all warnings will be reported as if they were errors. .. _class_ProjectSettings_property_debug/gdscript/warnings/unassigned_variable: - :ref:`bool` **debug/gdscript/warnings/unassigned_variable** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when using a variable that wasn't previously assigned. .. _class_ProjectSettings_property_debug/gdscript/warnings/unassigned_variable_op_assign: - :ref:`bool` **debug/gdscript/warnings/unassigned_variable_op_assign** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when assigning a variable using an assignment operator like ``+=`` if the variable wasn't previously assigned. .. _class_ProjectSettings_property_debug/gdscript/warnings/unreachable_code: - :ref:`bool` **debug/gdscript/warnings/unreachable_code** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when unreachable code is detected (such as after a ``return`` statement that will always be executed). .. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_call_argument: - :ref:`bool` **debug/gdscript/warnings/unsafe_call_argument** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, enables warnings when using an expression whose type may not be compatible with the function parameter expected. .. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_cast: - :ref:`bool` **debug/gdscript/warnings/unsafe_cast** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, enables warnings when performing an unsafe cast. .. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_method_access: - :ref:`bool` **debug/gdscript/warnings/unsafe_method_access** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, enables warnings when calling a method whose presence is not guaranteed at compile-time in the class. .. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_property_access: - :ref:`bool` **debug/gdscript/warnings/unsafe_property_access** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, enables warnings when accessing a property whose presence is not guaranteed at compile-time in the class. .. _class_ProjectSettings_property_debug/gdscript/warnings/unused_argument: - :ref:`bool` **debug/gdscript/warnings/unused_argument** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a function parameter is unused. .. _class_ProjectSettings_property_debug/gdscript/warnings/unused_class_variable: - :ref:`bool` **debug/gdscript/warnings/unused_class_variable** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a member variable is unused. .. _class_ProjectSettings_property_debug/gdscript/warnings/unused_signal: - :ref:`bool` **debug/gdscript/warnings/unused_signal** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a signal is unused. .. _class_ProjectSettings_property_debug/gdscript/warnings/unused_variable: - :ref:`bool` **debug/gdscript/warnings/unused_variable** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a local variable is unused. .. _class_ProjectSettings_property_debug/gdscript/warnings/variable_conflicts_function: - :ref:`bool` **debug/gdscript/warnings/variable_conflicts_function** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when a variable is declared with the same name as a function. This will turn into an error in a future version when first-class functions become supported in GDScript. .. _class_ProjectSettings_property_debug/gdscript/warnings/void_assignment: - :ref:`bool` **debug/gdscript/warnings/void_assignment** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables warnings when assigning the result of a function that returns ``void`` to a variable. .. _class_ProjectSettings_property_debug/settings/crash_handler/message: - :ref:`String` **debug/settings/crash_handler/message** ++-----------+---------------------------------------------------------------------------------------------+ +| *Default* | "Please include this when reporting the bug on https://github.com/godotengine/godot/issues" | ++-----------+---------------------------------------------------------------------------------------------+ + Message to be displayed before the backtrace when the engine crashes. .. _class_ProjectSettings_property_debug/settings/fps/force_fps: - :ref:`int` **debug/settings/fps/force_fps** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + .. _class_ProjectSettings_property_debug/settings/gdscript/max_call_stack: - :ref:`int` **debug/settings/gdscript/max_call_stack** ++-----------+------+ +| *Default* | 1024 | ++-----------+------+ + Maximum call stack allowed for debugging GDScript. .. _class_ProjectSettings_property_debug/settings/profiler/max_functions: - :ref:`int` **debug/settings/profiler/max_functions** ++-----------+-------+ +| *Default* | 16384 | ++-----------+-------+ + Maximum amount of functions per frame allowed when profiling. .. _class_ProjectSettings_property_debug/settings/stdout/print_fps: - :ref:`bool` **debug/settings/stdout/print_fps** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Print frames per second to standard output every second. .. _class_ProjectSettings_property_debug/settings/stdout/verbose_stdout: - :ref:`bool` **debug/settings/stdout/verbose_stdout** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Print more information to standard output when running. It displays information such as memory leaks, which scenes and resources are being loaded, etc. .. _class_ProjectSettings_property_debug/settings/visual_script/max_call_stack: - :ref:`int` **debug/settings/visual_script/max_call_stack** ++-----------+------+ +| *Default* | 1024 | ++-----------+------+ + Maximum call stack in visual scripting, to avoid infinite recursion. .. _class_ProjectSettings_property_display/mouse_cursor/custom_image: - :ref:`String` **display/mouse_cursor/custom_image** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + Custom image for the mouse cursor (limited to 256×256). .. _class_ProjectSettings_property_display/mouse_cursor/custom_image_hotspot: - :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ + Hotspot for the custom mouse cursor image. .. _class_ProjectSettings_property_display/mouse_cursor/tooltip_position_offset: - :ref:`Vector2` **display/mouse_cursor/tooltip_position_offset** ++-----------+-------------------+ +| *Default* | Vector2( 10, 10 ) | ++-----------+-------------------+ + Position offset for tooltips, relative to the mouse cursor's hotspot. .. _class_ProjectSettings_property_display/window/dpi/allow_hidpi: - :ref:`bool` **display/window/dpi/allow_hidpi** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, allows HiDPI display on Windows and macOS. This setting has no effect on desktop Linux, as DPI-awareness fallbacks are not supported there. .. _class_ProjectSettings_property_display/window/energy_saving/keep_screen_on: - :ref:`bool` **display/window/energy_saving/keep_screen_on** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, keeps the screen on (even in case of inactivity), so the screensaver does not take over. Works on desktop and mobile platforms. .. _class_ProjectSettings_property_display/window/handheld/orientation: - :ref:`String` **display/window/handheld/orientation** ++-----------+-------------+ +| *Default* | "landscape" | ++-----------+-------------+ + Default orientation on mobile devices. .. _class_ProjectSettings_property_display/window/per_pixel_transparency/allowed: - :ref:`bool` **display/window/per_pixel_transparency/allowed** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, allows per-pixel transparency in a desktop window. This affects performance, so leave it on ``false`` unless you need it. .. _class_ProjectSettings_property_display/window/per_pixel_transparency/enabled: - :ref:`bool` **display/window/per_pixel_transparency/enabled** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Sets the window background to transparent when it starts. .. _class_ProjectSettings_property_display/window/size/always_on_top: - :ref:`bool` **display/window/size/always_on_top** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Force the window to be always on top. .. _class_ProjectSettings_property_display/window/size/borderless: - :ref:`bool` **display/window/size/borderless** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Force the window to be borderless. .. _class_ProjectSettings_property_display/window/size/fullscreen: - :ref:`bool` **display/window/size/fullscreen** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Sets the window to full screen when it starts. .. _class_ProjectSettings_property_display/window/size/height: - :ref:`int` **display/window/size/height** ++-----------+-----+ +| *Default* | 600 | ++-----------+-----+ + Sets the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. .. _class_ProjectSettings_property_display/window/size/resizable: - :ref:`bool` **display/window/size/resizable** ++-----------+------+ +| *Default* | true | ++-----------+------+ + Allows the window to be resizable by default. .. _class_ProjectSettings_property_display/window/size/test_height: - :ref:`int` **display/window/size/test_height** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + If greater than zero, uses a different height for the window when running from the editor. The main use for this is to test with stretch modes. .. _class_ProjectSettings_property_display/window/size/test_width: - :ref:`int` **display/window/size/test_width** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + If greater than zero, uses a different width for the window when running from the editor. The main use for this is to test with stretch modes. .. _class_ProjectSettings_property_display/window/size/width: - :ref:`int` **display/window/size/width** ++-----------+------+ +| *Default* | 1024 | ++-----------+------+ + Sets the main window width. On desktop platforms, this is the default window size. Stretch mode settings use this also as a reference when enabled. .. _class_ProjectSettings_property_display/window/vsync/use_vsync: - :ref:`bool` **display/window/vsync/use_vsync** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, enables vertical synchronization. This eliminates tearing that may appear in moving scenes, at the cost of higher input latency and stuttering at lower framerates. If ``false``, vertical synchronization will be disabled, however, many platforms will enforce it regardless (such as mobile platforms and HTML5). .. _class_ProjectSettings_property_editor/active: - :ref:`bool` **editor/active** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Internal editor setting, don't touch. .. _class_ProjectSettings_property_editor/search_in_file_extensions: - :ref:`PoolStringArray` **editor/search_in_file_extensions** ++-----------+-----------------------------------+ +| *Default* | PoolStringArray( "gd", "shader" ) | ++-----------+-----------------------------------+ + .. _class_ProjectSettings_property_gui/common/default_scroll_deadzone: - :ref:`int` **gui/common/default_scroll_deadzone** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + .. _class_ProjectSettings_property_gui/common/swap_ok_cancel: - :ref:`bool` **gui/common/swap_ok_cancel** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, swaps OK and Cancel buttons in dialogs on Windows and UWP to follow interface conventions. .. _class_ProjectSettings_property_gui/theme/custom: - :ref:`String` **gui/theme/custom** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + Use a custom theme resource, set a path to it here. .. _class_ProjectSettings_property_gui/theme/custom_font: - :ref:`String` **gui/theme/custom_font** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + Use a custom default font resource, set a path to it here. .. _class_ProjectSettings_property_gui/theme/use_hidpi: - :ref:`bool` **gui/theme/use_hidpi** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, makes sure the theme used works with HiDPI. .. _class_ProjectSettings_property_gui/timers/incremental_search_max_interval_msec: - :ref:`int` **gui/timers/incremental_search_max_interval_msec** ++-----------+------+ +| *Default* | 2000 | ++-----------+------+ + Timer setting for incremental search in Tree, IntemList, etc. controls (in milliseconds). .. _class_ProjectSettings_property_gui/timers/text_edit_idle_detect_sec: - :ref:`float` **gui/timers/text_edit_idle_detect_sec** ++-----------+---+ +| *Default* | 3 | ++-----------+---+ + Timer for detecting idle in the editor (in seconds). .. _class_ProjectSettings_property_input/ui_accept: - :ref:`Dictionary` **input/ui_accept** ++-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777221,"unicode":0,"echo":false,"script":null) , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777222,"unicode":0,"echo":false,"script":null) , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":32,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":0,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_cancel: - :ref:`Dictionary` **input/ui_cancel** ++-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777217,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":1,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_down: - :ref:`Dictionary` **input/ui_down** ++-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777234,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":13,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_end: - :ref:`Dictionary` **input/ui_end** ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777230,"unicode":0,"echo":false,"script":null) ] } | ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_focus_next: - :ref:`Dictionary` **input/ui_focus_next** ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777218,"unicode":0,"echo":false,"script":null) ] } | ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_focus_prev: - :ref:`Dictionary` **input/ui_focus_prev** ++-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":true,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777218,"unicode":0,"echo":false,"script":null) ] } | ++-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_home: - :ref:`Dictionary` **input/ui_home** ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777229,"unicode":0,"echo":false,"script":null) ] } | ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_left: - :ref:`Dictionary` **input/ui_left** ++-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777231,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":14,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_page_down: - :ref:`Dictionary` **input/ui_page_down** ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777236,"unicode":0,"echo":false,"script":null) ] } | ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_page_up: - :ref:`Dictionary` **input/ui_page_up** ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777235,"unicode":0,"echo":false,"script":null) ] } | ++-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_right: - :ref:`Dictionary` **input/ui_right** ++-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777233,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":15,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_select: - :ref:`Dictionary` **input/ui_select** ++-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":32,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":3,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input/ui_up: - :ref:`Dictionary` **input/ui_up** ++-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | { "deadzone": 0.5, "events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":16777232,"unicode":0,"echo":false,"script":null) , Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":0,"button_index":12,"pressure":0.0,"pressed":false,"script":null) ] } | ++-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _class_ProjectSettings_property_input_devices/pointing/emulate_mouse_from_touch: - :ref:`bool` **input_devices/pointing/emulate_mouse_from_touch** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, sends mouse input events when tapping or swiping on the touchscreen. .. _class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse: - :ref:`bool` **input_devices/pointing/emulate_touch_from_mouse** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, sends touch input events when clicking or dragging the mouse. .. _class_ProjectSettings_property_layer_names/2d_physics/layer_1: - :ref:`String` **layer_names/2d_physics/layer_1** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_10: - :ref:`String` **layer_names/2d_physics/layer_10** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_11: - :ref:`String` **layer_names/2d_physics/layer_11** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_12: - :ref:`String` **layer_names/2d_physics/layer_12** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_13: - :ref:`String` **layer_names/2d_physics/layer_13** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_14: - :ref:`String` **layer_names/2d_physics/layer_14** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_15: - :ref:`String` **layer_names/2d_physics/layer_15** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_16: - :ref:`String` **layer_names/2d_physics/layer_16** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_17: - :ref:`String` **layer_names/2d_physics/layer_17** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_18: - :ref:`String` **layer_names/2d_physics/layer_18** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_19: - :ref:`String` **layer_names/2d_physics/layer_19** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_2: - :ref:`String` **layer_names/2d_physics/layer_2** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_20: - :ref:`String` **layer_names/2d_physics/layer_20** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_3: - :ref:`String` **layer_names/2d_physics/layer_3** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_4: - :ref:`String` **layer_names/2d_physics/layer_4** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_5: - :ref:`String` **layer_names/2d_physics/layer_5** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_6: - :ref:`String` **layer_names/2d_physics/layer_6** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_7: - :ref:`String` **layer_names/2d_physics/layer_7** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_8: - :ref:`String` **layer_names/2d_physics/layer_8** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_physics/layer_9: - :ref:`String` **layer_names/2d_physics/layer_9** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_1: - :ref:`String` **layer_names/2d_render/layer_1** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_10: - :ref:`String` **layer_names/2d_render/layer_10** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_11: - :ref:`String` **layer_names/2d_render/layer_11** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_12: - :ref:`String` **layer_names/2d_render/layer_12** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_13: - :ref:`String` **layer_names/2d_render/layer_13** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_14: - :ref:`String` **layer_names/2d_render/layer_14** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_15: - :ref:`String` **layer_names/2d_render/layer_15** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_16: - :ref:`String` **layer_names/2d_render/layer_16** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_17: - :ref:`String` **layer_names/2d_render/layer_17** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_18: - :ref:`String` **layer_names/2d_render/layer_18** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_19: - :ref:`String` **layer_names/2d_render/layer_19** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_2: - :ref:`String` **layer_names/2d_render/layer_2** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_20: - :ref:`String` **layer_names/2d_render/layer_20** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_3: - :ref:`String` **layer_names/2d_render/layer_3** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_4: - :ref:`String` **layer_names/2d_render/layer_4** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_5: - :ref:`String` **layer_names/2d_render/layer_5** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_6: - :ref:`String` **layer_names/2d_render/layer_6** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_7: - :ref:`String` **layer_names/2d_render/layer_7** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_8: - :ref:`String` **layer_names/2d_render/layer_8** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/2d_render/layer_9: - :ref:`String` **layer_names/2d_render/layer_9** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_1: - :ref:`String` **layer_names/3d_physics/layer_1** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_10: - :ref:`String` **layer_names/3d_physics/layer_10** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_11: - :ref:`String` **layer_names/3d_physics/layer_11** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_12: - :ref:`String` **layer_names/3d_physics/layer_12** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_13: - :ref:`String` **layer_names/3d_physics/layer_13** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_14: - :ref:`String` **layer_names/3d_physics/layer_14** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_15: - :ref:`String` **layer_names/3d_physics/layer_15** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_16: - :ref:`String` **layer_names/3d_physics/layer_16** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_17: - :ref:`String` **layer_names/3d_physics/layer_17** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_18: - :ref:`String` **layer_names/3d_physics/layer_18** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_19: - :ref:`String` **layer_names/3d_physics/layer_19** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_2: - :ref:`String` **layer_names/3d_physics/layer_2** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_20: - :ref:`String` **layer_names/3d_physics/layer_20** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_3: - :ref:`String` **layer_names/3d_physics/layer_3** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_4: - :ref:`String` **layer_names/3d_physics/layer_4** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_5: - :ref:`String` **layer_names/3d_physics/layer_5** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_6: - :ref:`String` **layer_names/3d_physics/layer_6** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_7: - :ref:`String` **layer_names/3d_physics/layer_7** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_8: - :ref:`String` **layer_names/3d_physics/layer_8** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_physics/layer_9: - :ref:`String` **layer_names/3d_physics/layer_9** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_1: - :ref:`String` **layer_names/3d_render/layer_1** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_10: - :ref:`String` **layer_names/3d_render/layer_10** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_11: - :ref:`String` **layer_names/3d_render/layer_11** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_12: - :ref:`String` **layer_names/3d_render/layer_12** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_13: - :ref:`String` **layer_names/3d_render/layer_13** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_14: - :ref:`String` **layer_names/3d_render/layer_14** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_15: - :ref:`String` **layer_names/3d_render/layer_15** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_16: - :ref:`String` **layer_names/3d_render/layer_16** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_17: - :ref:`String` **layer_names/3d_render/layer_17** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_18: - :ref:`String` **layer_names/3d_render/layer_18** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_19: - :ref:`String` **layer_names/3d_render/layer_19** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_2: - :ref:`String` **layer_names/3d_render/layer_2** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_20: - :ref:`String` **layer_names/3d_render/layer_20** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_3: - :ref:`String` **layer_names/3d_render/layer_3** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_4: - :ref:`String` **layer_names/3d_render/layer_4** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_5: - :ref:`String` **layer_names/3d_render/layer_5** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_6: - :ref:`String` **layer_names/3d_render/layer_6** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_7: - :ref:`String` **layer_names/3d_render/layer_7** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_8: - :ref:`String` **layer_names/3d_render/layer_8** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_layer_names/3d_render/layer_9: - :ref:`String` **layer_names/3d_render/layer_9** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + .. _class_ProjectSettings_property_locale/fallback: - :ref:`String` **locale/fallback** ++-----------+------+ +| *Default* | "en" | ++-----------+------+ + The locale to fall back to if a translation isn't available in a given language. If left empty, ``en`` (English) will be used. .. _class_ProjectSettings_property_locale/test: - :ref:`String` **locale/test** ++-----------+----+ +| *Default* | "" | ++-----------+----+ + If non-empty, this locale will be used when running the project from the editor. .. _class_ProjectSettings_property_logging/file_logging/enable_file_logging: - :ref:`bool` **logging/file_logging/enable_file_logging** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, logs all output to files. .. _class_ProjectSettings_property_logging/file_logging/log_path: - :ref:`String` **logging/file_logging/log_path** ++-----------+-----------------------+ +| *Default* | "user://logs/log.txt" | ++-----------+-----------------------+ + Path to logs within the project. Using an ``user://`` path is recommended. .. _class_ProjectSettings_property_logging/file_logging/max_log_files: - :ref:`int` **logging/file_logging/max_log_files** ++-----------+----+ +| *Default* | 10 | ++-----------+----+ + Specifies the maximum amount of log files allowed (used for rotation). .. _class_ProjectSettings_property_memory/limits/message_queue/max_size_kb: - :ref:`int` **memory/limits/message_queue/max_size_kb** ++-----------+------+ +| *Default* | 1024 | ++-----------+------+ + Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. .. _class_ProjectSettings_property_memory/limits/multithreaded_server/rid_pool_prealloc: - :ref:`int` **memory/limits/multithreaded_server/rid_pool_prealloc** ++-----------+----+ +| *Default* | 60 | ++-----------+----+ + This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. .. _class_ProjectSettings_property_network/limits/debugger_stdout/max_chars_per_second: - :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** ++-----------+------+ +| *Default* | 2048 | ++-----------+------+ + Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. .. _class_ProjectSettings_property_network/limits/debugger_stdout/max_errors_per_frame: - :ref:`int` **network/limits/debugger_stdout/max_errors_per_frame** ++-----------+----+ +| *Default* | 10 | ++-----------+----+ + Maximum amount of errors allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. .. _class_ProjectSettings_property_network/limits/debugger_stdout/max_messages_per_frame: - :ref:`int` **network/limits/debugger_stdout/max_messages_per_frame** ++-----------+----+ +| *Default* | 10 | ++-----------+----+ + Maximum amount of messages allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. .. _class_ProjectSettings_property_network/limits/packet_peer_stream/max_buffer_po2: - :ref:`int` **network/limits/packet_peer_stream/max_buffer_po2** ++-----------+----+ +| *Default* | 16 | ++-----------+----+ + Default size of packet peer stream for deserializing Godot data. Over this size, data is dropped. .. _class_ProjectSettings_property_network/limits/websocket_client/max_in_buffer_kb: - :ref:`int` **network/limits/websocket_client/max_in_buffer_kb** ++-----------+----+ +| *Default* | 64 | ++-----------+----+ + .. _class_ProjectSettings_property_network/limits/websocket_client/max_in_packets: - :ref:`int` **network/limits/websocket_client/max_in_packets** ++-----------+------+ +| *Default* | 1024 | ++-----------+------+ + .. _class_ProjectSettings_property_network/limits/websocket_client/max_out_buffer_kb: - :ref:`int` **network/limits/websocket_client/max_out_buffer_kb** ++-----------+----+ +| *Default* | 64 | ++-----------+----+ + .. _class_ProjectSettings_property_network/limits/websocket_client/max_out_packets: - :ref:`int` **network/limits/websocket_client/max_out_packets** ++-----------+------+ +| *Default* | 1024 | ++-----------+------+ + .. _class_ProjectSettings_property_network/limits/websocket_server/max_in_buffer_kb: - :ref:`int` **network/limits/websocket_server/max_in_buffer_kb** ++-----------+----+ +| *Default* | 64 | ++-----------+----+ + .. _class_ProjectSettings_property_network/limits/websocket_server/max_in_packets: - :ref:`int` **network/limits/websocket_server/max_in_packets** ++-----------+------+ +| *Default* | 1024 | ++-----------+------+ + .. _class_ProjectSettings_property_network/limits/websocket_server/max_out_buffer_kb: - :ref:`int` **network/limits/websocket_server/max_out_buffer_kb** ++-----------+----+ +| *Default* | 64 | ++-----------+----+ + .. _class_ProjectSettings_property_network/limits/websocket_server/max_out_packets: - :ref:`int` **network/limits/websocket_server/max_out_packets** ++-----------+------+ +| *Default* | 1024 | ++-----------+------+ + .. _class_ProjectSettings_property_network/remote_fs/page_read_ahead: - :ref:`int` **network/remote_fs/page_read_ahead** ++-----------+---+ +| *Default* | 4 | ++-----------+---+ + Amount of read ahead used by remote filesystem. Higher values decrease the effects of latency at the cost of higher bandwidth usage. .. _class_ProjectSettings_property_network/remote_fs/page_size: - :ref:`int` **network/remote_fs/page_size** ++-----------+-------+ +| *Default* | 65536 | ++-----------+-------+ + Page size used by remote filesystem (in bytes). .. _class_ProjectSettings_property_node/name_casing: - :ref:`int` **node/name_casing** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + When creating node names automatically, set the type of casing in this project. This is mostly an editor setting. .. _class_ProjectSettings_property_node/name_num_separator: - :ref:`int` **node/name_num_separator** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + What to use to separate node name from number. This is mostly an editor setting. +.. _class_ProjectSettings_property_physics/2d/default_gravity: + +- :ref:`int` **physics/2d/default_gravity** + ++-----------+----+ +| *Default* | 98 | ++-----------+----+ + .. _class_ProjectSettings_property_physics/2d/physics_engine: - :ref:`String` **physics/2d/physics_engine** ++-----------+-----------+ +| *Default* | "DEFAULT" | ++-----------+-----------+ + .. _class_ProjectSettings_property_physics/2d/thread_model: - :ref:`int` **physics/2d/thread_model** ++-----------+---+ +| *Default* | 1 | ++-----------+---+ + Sets whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API access to only physics process. .. _class_ProjectSettings_property_physics/3d/active_soft_world: - :ref:`bool` **physics/3d/active_soft_world** ++-----------+------+ +| *Default* | true | ++-----------+------+ + +.. _class_ProjectSettings_property_physics/3d/default_gravity: + +- :ref:`float` **physics/3d/default_gravity** + ++-----------+-----+ +| *Default* | 9.8 | ++-----------+-----+ + .. _class_ProjectSettings_property_physics/3d/physics_engine: - :ref:`String` **physics/3d/physics_engine** ++-----------+-----------+ +| *Default* | "DEFAULT" | ++-----------+-----------+ + Sets which physics engine to use. .. _class_ProjectSettings_property_physics/common/physics_fps: - :ref:`int` **physics/common/physics_fps** ++-----------+----+ +| *Default* | 60 | ++-----------+----+ + Frames per second used in the physics. Physics always needs a fixed amount of frames per second. .. _class_ProjectSettings_property_physics/common/physics_jitter_fix: - :ref:`float` **physics/common/physics_jitter_fix** ++-----------+-----+ +| *Default* | 0.5 | ++-----------+-----+ + Fix to improve physics jitter, specially on monitors where refresh rate is different than the physics FPS. .. _class_ProjectSettings_property_rendering/environment/default_clear_color: - :ref:`Color` **rendering/environment/default_clear_color** ++-----------+---------------------------+ +| *Default* | Color( 0.3, 0.3, 0.3, 1 ) | ++-----------+---------------------------+ + Default background clear color. Overriddable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`VisualServer.set_default_clear_color`. .. _class_ProjectSettings_property_rendering/limits/buffers/blend_shape_max_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/blend_shape_max_buffer_size_kb** ++-----------+------+ +| *Default* | 4096 | ++-----------+------+ + Max buffer size for blend shapes. Any blend shape bigger than this will not work. .. _class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/canvas_polygon_buffer_size_kb** ++-----------+-----+ +| *Default* | 128 | ++-----------+-----+ + Max buffer size for drawing polygons. Any polygon bigger than this will not work. .. _class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/canvas_polygon_index_buffer_size_kb** ++-----------+-----+ +| *Default* | 128 | ++-----------+-----+ + Max index buffer size for drawing polygons. Any polygon bigger than this will not work. .. _class_ProjectSettings_property_rendering/limits/buffers/immediate_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/immediate_buffer_size_kb** ++-----------+------+ +| *Default* | 2048 | ++-----------+------+ + Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. .. _class_ProjectSettings_property_rendering/limits/rendering/max_renderable_elements: - :ref:`int` **rendering/limits/rendering/max_renderable_elements** ++-----------+-------+ +| *Default* | 65536 | ++-----------+-------+ + Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves. .. _class_ProjectSettings_property_rendering/limits/time/time_rollover_secs: - :ref:`float` **rendering/limits/time/time_rollover_secs** ++-----------+------+ +| *Default* | 3600 | ++-----------+------+ + Shaders have a time variable that constantly increases. At some point, it needs to be rolled back to zero to avoid precision errors on shader animations. This setting specifies when (in seconds). .. _class_ProjectSettings_property_rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround: - :ref:`bool` **rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Some NVIDIA GPU drivers have a bug which produces flickering issues for the ``draw_rect`` method, especially as used in :ref:`TileMap`. Refer to `GitHub issue 9913 `_ for details. If ``true``, this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend (so the bug stays if you use GLES3), and only desktop platforms. @@ -1734,34 +2654,58 @@ If ``true``, this option enables a "safe" code path for such NVIDIA GPUs at the - :ref:`bool` **rendering/quality/2d/use_pixel_snap** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. .. _class_ProjectSettings_property_rendering/quality/depth_prepass/disable_for_vendors: - :ref:`String` **rendering/quality/depth_prepass/disable_for_vendors** ++-----------+-----------------------------+ +| *Default* | "PowerVR,Mali,Adreno,Apple" | ++-----------+-----------------------------+ + Disables depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. .. _class_ProjectSettings_property_rendering/quality/depth_prepass/enable: - :ref:`bool` **rendering/quality/depth_prepass/enable** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. .. _class_ProjectSettings_property_rendering/quality/directional_shadow/size: - :ref:`int` **rendering/quality/directional_shadow/size** ++-----------+------+ +| *Default* | 4096 | ++-----------+------+ + The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. .. _class_ProjectSettings_property_rendering/quality/directional_shadow/size.mobile: - :ref:`int` **rendering/quality/directional_shadow/size.mobile** ++-----------+------+ +| *Default* | 2048 | ++-----------+------+ + .. _class_ProjectSettings_property_rendering/quality/driver/driver_name: - :ref:`String` **rendering/quality/driver/driver_name** ++-----------+---------+ +| *Default* | "GLES3" | ++-----------+---------+ + The video driver to use ("GLES2" or "GLES3"). **Note:** The backend in use can be overridden at runtime via the ``--video-driver`` command line argument, or by the :ref:`rendering/quality/driver/fallback_to_gles2` option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use :ref:`OS.get_current_video_driver` to query it at run-time. @@ -1770,6 +2714,10 @@ The video driver to use ("GLES2" or "GLES3"). - :ref:`bool` **rendering/quality/driver/fallback_to_gles2** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, allows falling back to the GLES2 driver if the GLES3 driver is not supported. **Note:** The two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the data pack's size. @@ -1778,186 +2726,322 @@ If ``true``, allows falling back to the GLES2 driver if the GLES3 driver is not - :ref:`int` **rendering/quality/filters/anisotropic_filter_level** ++-----------+---+ +| *Default* | 4 | ++-----------+---+ + Maximum anisotropic filter level used for textures with anisotropy enabled. Higher values will result in sharper textures when viewed from oblique angles, at the cost of performance. Only power-of-two values are valid (2, 4, 8, 16). .. _class_ProjectSettings_property_rendering/quality/filters/use_nearest_mipmap_filter: - :ref:`bool` **rendering/quality/filters/use_nearest_mipmap_filter** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If ``false``, linear mipmap filtering (also called "trilinear filtering") is used. .. _class_ProjectSettings_property_rendering/quality/intended_usage/framebuffer_allocation: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation** ++-----------+---+ +| *Default* | 2 | ++-----------+---+ + Strategy used for framebuffer allocation. The simpler it is, the less resources it uses (but the less features it supports). .. _class_ProjectSettings_property_rendering/quality/intended_usage/framebuffer_allocation.mobile: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation.mobile** ++-----------+---+ +| *Default* | 3 | ++-----------+---+ + .. _class_ProjectSettings_property_rendering/quality/reflections/high_quality_ggx: - :ref:`bool` **rendering/quality/reflections/high_quality_ggx** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, uses a high amount of samples to create blurred variants of reflection probes and panorama backgrounds (sky). Those blurred variants are used by rough materials. .. _class_ProjectSettings_property_rendering/quality/reflections/high_quality_ggx.mobile: - :ref:`bool` **rendering/quality/reflections/high_quality_ggx.mobile** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + .. _class_ProjectSettings_property_rendering/quality/reflections/texture_array_reflections: - :ref:`bool` **rendering/quality/reflections/texture_array_reflections** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise on reflections, but costs more performance and memory. .. _class_ProjectSettings_property_rendering/quality/reflections/texture_array_reflections.mobile: - :ref:`bool` **rendering/quality/reflections/texture_array_reflections.mobile** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + .. _class_ProjectSettings_property_rendering/quality/shading/force_blinn_over_ggx: - :ref:`bool` **rendering/quality/shading/force_blinn_over_ggx** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, uses faster but lower-quality Blinn model to generate blurred reflections instead of the GGX model. .. _class_ProjectSettings_property_rendering/quality/shading/force_blinn_over_ggx.mobile: - :ref:`bool` **rendering/quality/shading/force_blinn_over_ggx.mobile** ++-----------+------+ +| *Default* | true | ++-----------+------+ + .. _class_ProjectSettings_property_rendering/quality/shading/force_lambert_over_burley: - :ref:`bool` **rendering/quality/shading/force_lambert_over_burley** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, uses faster but lower-quality Lambert material lighting model instead of Burley. .. _class_ProjectSettings_property_rendering/quality/shading/force_lambert_over_burley.mobile: - :ref:`bool` **rendering/quality/shading/force_lambert_over_burley.mobile** ++-----------+------+ +| *Default* | true | ++-----------+------+ + .. _class_ProjectSettings_property_rendering/quality/shading/force_vertex_shading: - :ref:`bool` **rendering/quality/shading/force_vertex_shading** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices. .. _class_ProjectSettings_property_rendering/quality/shading/force_vertex_shading.mobile: - :ref:`bool` **rendering/quality/shading/force_vertex_shading.mobile** ++-----------+------+ +| *Default* | true | ++-----------+------+ + .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_0_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_0_subdiv** ++-----------+---+ +| *Default* | 1 | ++-----------+---+ + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_1_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_1_subdiv** ++-----------+---+ +| *Default* | 2 | ++-----------+---+ + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_2_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_2_subdiv** ++-----------+---+ +| *Default* | 3 | ++-----------+---+ + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_3_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_3_subdiv** ++-----------+---+ +| *Default* | 4 | ++-----------+---+ + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/size: - :ref:`int` **rendering/quality/shadow_atlas/size** ++-----------+------+ +| *Default* | 4096 | ++-----------+------+ + Size for shadow atlas (used for OmniLights and SpotLights). See documentation. .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/size.mobile: - :ref:`int` **rendering/quality/shadow_atlas/size.mobile** ++-----------+------+ +| *Default* | 2048 | ++-----------+------+ + .. _class_ProjectSettings_property_rendering/quality/shadows/filter_mode: - :ref:`int` **rendering/quality/shadows/filter_mode** ++-----------+---+ +| *Default* | 1 | ++-----------+---+ + Shadow filter mode. Higher-quality settings result in smoother shadows that flicker less when moving. "Disabled" is the fastest option, but also has the lowest quality. "PCF5" is smoother but is also slower. "PCF13" is the smoothest option, but is also the slowest. .. _class_ProjectSettings_property_rendering/quality/shadows/filter_mode.mobile: - :ref:`int` **rendering/quality/shadows/filter_mode.mobile** ++-----------+---+ +| *Default* | 0 | ++-----------+---+ + .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/follow_surface: - :ref:`bool` **rendering/quality/subsurface_scattering/follow_surface** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + Improves quality of subsurface scattering, but cost significantly increases. .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/quality: - :ref:`int` **rendering/quality/subsurface_scattering/quality** ++-----------+---+ +| *Default* | 1 | ++-----------+---+ + Quality setting for subsurface scaterring (samples taken). .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/scale: - :ref:`int` **rendering/quality/subsurface_scattering/scale** ++-----------+-----+ +| *Default* | 1.0 | ++-----------+-----+ + .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/weight_samples: - :ref:`bool` **rendering/quality/subsurface_scattering/weight_samples** ++-----------+------+ +| *Default* | true | ++-----------+------+ + Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. .. _class_ProjectSettings_property_rendering/quality/voxel_cone_tracing/high_quality: - :ref:`bool` **rendering/quality/voxel_cone_tracing/high_quality** ++-----------+------+ +| *Default* | true | ++-----------+------+ + Use high-quality voxel cone tracing. This results in better-looking reflections, but is much more expensive on the GPU. .. _class_ProjectSettings_property_rendering/threads/thread_model: - :ref:`int` **rendering/threads/thread_model** ++-----------+---+ +| *Default* | 1 | ++-----------+---+ + Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter. .. _class_ProjectSettings_property_rendering/vram_compression/import_bptc: - :ref:`bool` **rendering/vram_compression/import_bptc** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the GLES3 renderer. .. _class_ProjectSettings_property_rendering/vram_compression/import_etc: - :ref:`bool` **rendering/vram_compression/import_etc** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression algorithm. This algorithm doesn't support alpha channels in textures. .. _class_ProjectSettings_property_rendering/vram_compression/import_etc2: - :ref:`bool` **rendering/vram_compression/import_etc2** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the GLES3 renderer. .. _class_ProjectSettings_property_rendering/vram_compression/import_pvrtc: - :ref:`bool` **rendering/vram_compression/import_pvrtc** ++-----------+-------+ +| *Default* | false | ++-----------+-------+ + If ``true``, the texture importer will import VRAM-compressed textures using the PowerVR Texture Compression algorithm. This texture compression algorithm is only supported on iOS. .. _class_ProjectSettings_property_rendering/vram_compression/import_s3tc: - :ref:`bool` **rendering/vram_compression/import_s3tc** ++-----------+------+ +| *Default* | true | ++-----------+------+ + If ``true``, the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles. .. _class_ProjectSettings_property_script: - :ref:`Script` **script** ++-----------+------+ +| *Default* | null | ++-----------+------+ + Method Descriptions ------------------- diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 92f2b674a..05376a3d8 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -19,13 +19,13 @@ General-purpose proximity detection node. Properties ---------- -+-------------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`DispatchMode` | :ref:`dispatch_mode` | -+-------------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`grid_radius` | -+-------------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`String` | :ref:`group_name` | -+-------------------------------------------------------+-------------------------------------------------------------------+ ++-------------------------------------------------------+-------------------------------------------------------------------+--------------------+ +| :ref:`DispatchMode` | :ref:`dispatch_mode` | 0 | ++-------------------------------------------------------+-------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`grid_radius` | Vector3( 1, 1, 1 ) | ++-------------------------------------------------------+-------------------------------------------------------------------+--------------------+ +| :ref:`String` | :ref:`group_name` | "" | ++-------------------------------------------------------+-------------------------------------------------------------------+--------------------+ Methods ------- @@ -68,31 +68,37 @@ Property Descriptions - :ref:`DispatchMode` **dispatch_mode** -+----------+--------------------------+ -| *Setter* | set_dispatch_mode(value) | -+----------+--------------------------+ -| *Getter* | get_dispatch_mode() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_dispatch_mode(value) | ++-----------+--------------------------+ +| *Getter* | get_dispatch_mode() | ++-----------+--------------------------+ .. _class_ProximityGroup_property_grid_radius: - :ref:`Vector3` **grid_radius** -+----------+------------------------+ -| *Setter* | set_grid_radius(value) | -+----------+------------------------+ -| *Getter* | get_grid_radius() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Vector3( 1, 1, 1 ) | ++-----------+------------------------+ +| *Setter* | set_grid_radius(value) | ++-----------+------------------------+ +| *Getter* | get_grid_radius() | ++-----------+------------------------+ .. _class_ProximityGroup_property_group_name: - :ref:`String` **group_name** -+----------+-----------------------+ -| *Setter* | set_group_name(value) | -+----------+-----------------------+ -| *Getter* | get_group_name() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | "" | ++-----------+-----------------------+ +| *Setter* | set_group_name(value) | ++-----------+-----------------------+ +| *Getter* | get_group_name() | ++-----------+-----------------------+ Method Descriptions ------------------- diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index 3b12fd7f4..aad46c680 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------------+-----------------------------------------------+ -| :ref:`Texture` | :ref:`base` | -+-------------------------------+-----------------------------------------------+ ++-------------------------------+-----------------------------------------------+------+ +| :ref:`Texture` | :ref:`base` | null | ++-------------------------------+-----------------------------------------------+------+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`Texture` **base** -+----------+-----------------+ -| *Setter* | set_base(value) | -+----------+-----------------+ -| *Getter* | get_base() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | null | ++-----------+-----------------+ +| *Setter* | set_base(value) | ++-----------+-----------------+ +| *Getter* | get_base() | ++-----------+-----------------+ diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index d44fcb330..0831b7bfa 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -19,9 +19,9 @@ Class representing a square mesh. Properties ---------- -+-------------------------------+-------------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+-------------------------------+-------------------------------------------+ ++-------------------------------+-------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`size` | Vector2( 1, 1 ) | ++-------------------------------+-------------------------------------------+-----------------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`Vector2` **size** -+----------+-----------------+ -| *Setter* | set_size(value) | -+----------+-----------------+ -| *Getter* | get_size() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | Vector2( 1, 1 ) | ++-----------+-----------------+ +| *Setter* | set_size(value) | ++-----------+-----------------+ +| *Getter* | get_size() | ++-----------+-----------------+ -Size in the X and Y axes. Default is ``Vector2(1, 1)``. +Size on the X and Y axes. diff --git a/classes/class_quat.rst b/classes/class_quat.rst index abdaaa7aa..726ff186a 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -17,15 +17,15 @@ Quaternion. Properties ---------- -+---------------------------+---------------------------------+ -| :ref:`float` | :ref:`w` | -+---------------------------+---------------------------------+ -| :ref:`float` | :ref:`x` | -+---------------------------+---------------------------------+ -| :ref:`float` | :ref:`y` | -+---------------------------+---------------------------------+ -| :ref:`float` | :ref:`z` | -+---------------------------+---------------------------------+ ++---------------------------+---------------------------------+-----+ +| :ref:`float` | :ref:`w` | 1.0 | ++---------------------------+---------------------------------+-----+ +| :ref:`float` | :ref:`x` | 0.0 | ++---------------------------+---------------------------------+-----+ +| :ref:`float` | :ref:`y` | 0.0 | ++---------------------------+---------------------------------+-----+ +| :ref:`float` | :ref:`z` | 0.0 | ++---------------------------+---------------------------------+-----+ Methods ------- @@ -94,25 +94,41 @@ Property Descriptions - :ref:`float` **w** -W component of the quaternion. Default value: ``1``. ++-----------+-----+ +| *Default* | 1.0 | ++-----------+-----+ + +W component of the quaternion. .. _class_Quat_property_x: - :ref:`float` **x** -X component of the quaternion. Default value: ``0``. ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + +X component of the quaternion. .. _class_Quat_property_y: - :ref:`float` **y** -Y component of the quaternion. Default value: ``0``. ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + +Y component of the quaternion. .. _class_Quat_property_z: - :ref:`float` **z** -Z component of the quaternion. Default value: ``0``. ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + +Z component of the quaternion. Method Descriptions ------------------- diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index af7344260..16997cffa 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -19,9 +19,9 @@ A class for generating pseudo-random numbers. Properties ---------- -+-----------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`seed` | -+-----------------------+--------------------------------------------------------+ ++-----------------------+--------------------------------------------------------+----------------------+ +| :ref:`int` | :ref:`seed` | -6398989897141750821 | ++-----------------------+--------------------------------------------------------+----------------------+ Methods ------- @@ -47,6 +47,15 @@ RandomNumberGenerator is a class for generating pseudo-random numbers. It curren **Note:** The underlying algorithm is an implementation detail. As a result, it should not be depended upon for reproducible random streams across Godot versions. +To generate a random float number (within a given range) based on a time-dependant seed: + +:: + + var rng = RandomNumberGenerator.new() + func _ready(): + rng.randomize() + var my_random_number = rng.randf_range(-10.0, 10.0) + Property Descriptions --------------------- @@ -54,11 +63,13 @@ Property Descriptions - :ref:`int` **seed** -+----------+-----------------+ -| *Setter* | set_seed(value) | -+----------+-----------------+ -| *Getter* | get_seed() | -+----------+-----------------+ ++-----------+----------------------+ +| *Default* | -6398989897141750821 | ++-----------+----------------------+ +| *Setter* | set_seed(value) | ++-----------+----------------------+ +| *Getter* | get_seed() | ++-----------+----------------------+ The seed used by the random number generator. A given seed will give a reproducible sequence of pseudo-random numbers. diff --git a/classes/class_range.rst b/classes/class_range.rst index accc97d3e..4be01e9c9 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -21,27 +21,27 @@ Abstract base class for range-based controls. Properties ---------- -+---------------------------+----------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_greater` | -+---------------------------+----------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_lesser` | -+---------------------------+----------------------------------------------------------+ -| :ref:`bool` | :ref:`exp_edit` | -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`max_value` | -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`min_value` | -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`page` | -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`ratio` | -+---------------------------+----------------------------------------------------------+ -| :ref:`bool` | :ref:`rounded` | -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`step` | -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`value` | -+---------------------------+----------------------------------------------------------+ ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`allow_greater` | false | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`allow_lesser` | false | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`exp_edit` | false | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`float` | :ref:`max_value` | 100.0 | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`float` | :ref:`min_value` | 0.0 | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`float` | :ref:`page` | 0.0 | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`float` | :ref:`ratio` | | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`rounded` | false | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`float` | :ref:`step` | 1.0 | ++---------------------------+----------------------------------------------------------+-------+ +| :ref:`float` | :ref:`value` | 0.0 | ++---------------------------+----------------------------------------------------------+-------+ Methods ------- @@ -79,35 +79,41 @@ Property Descriptions - :ref:`bool` **allow_greater** -+----------+--------------------------+ -| *Setter* | set_allow_greater(value) | -+----------+--------------------------+ -| *Getter* | is_greater_allowed() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_allow_greater(value) | ++-----------+--------------------------+ +| *Getter* | is_greater_allowed() | ++-----------+--------------------------+ -If ``true``, :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. +If ``true``, :ref:`value` may be greater than :ref:`max_value`. .. _class_Range_property_allow_lesser: - :ref:`bool` **allow_lesser** -+----------+-------------------------+ -| *Setter* | set_allow_lesser(value) | -+----------+-------------------------+ -| *Getter* | is_lesser_allowed() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_allow_lesser(value) | ++-----------+-------------------------+ +| *Getter* | is_lesser_allowed() | ++-----------+-------------------------+ -If ``true``, :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. +If ``true``, :ref:`value` may be less than :ref:`min_value`. .. _class_Range_property_exp_edit: - :ref:`bool` **exp_edit** -+----------+----------------------+ -| *Setter* | set_exp_ratio(value) | -+----------+----------------------+ -| *Getter* | is_ratio_exp() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_exp_ratio(value) | ++-----------+----------------------+ +| *Getter* | is_ratio_exp() | ++-----------+----------------------+ If ``true``, and ``min_value`` is greater than 0, ``value`` will be represented exponentially rather than linearly. @@ -115,35 +121,41 @@ If ``true``, and ``min_value`` is greater than 0, ``value`` will be represented - :ref:`float` **max_value** -+----------+----------------+ -| *Setter* | set_max(value) | -+----------+----------------+ -| *Getter* | get_max() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | 100.0 | ++-----------+----------------+ +| *Setter* | set_max(value) | ++-----------+----------------+ +| *Getter* | get_max() | ++-----------+----------------+ -Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: ``100``. +Maximum value. Range is clamped if ``value`` is greater than ``max_value``. .. _class_Range_property_min_value: - :ref:`float` **min_value** -+----------+----------------+ -| *Setter* | set_min(value) | -+----------+----------------+ -| *Getter* | get_min() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | 0.0 | ++-----------+----------------+ +| *Setter* | set_min(value) | ++-----------+----------------+ +| *Getter* | get_min() | ++-----------+----------------+ -Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: ``0``. +Minimum value. Range is clamped if ``value`` is less than ``min_value``. .. _class_Range_property_page: - :ref:`float` **page** -+----------+-----------------+ -| *Setter* | set_page(value) | -+----------+-----------------+ -| *Getter* | get_page() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0.0 | ++-----------+-----------------+ +| *Setter* | set_page(value) | ++-----------+-----------------+ +| *Getter* | get_page() | ++-----------+-----------------+ Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length is its size multiplied by ``page`` over the difference between ``min_value`` and ``max_value``. @@ -163,23 +175,27 @@ The value mapped between 0 and 1. - :ref:`bool` **rounded** -+----------+-------------------------------+ -| *Setter* | set_use_rounded_values(value) | -+----------+-------------------------------+ -| *Getter* | is_using_rounded_values() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | false | ++-----------+-------------------------------+ +| *Setter* | set_use_rounded_values(value) | ++-----------+-------------------------------+ +| *Getter* | is_using_rounded_values() | ++-----------+-------------------------------+ -If ``true``, ``value`` will always be rounded to the nearest integer. Default value: ``false``. +If ``true``, ``value`` will always be rounded to the nearest integer. .. _class_Range_property_step: - :ref:`float` **step** -+----------+-----------------+ -| *Setter* | set_step(value) | -+----------+-----------------+ -| *Getter* | get_step() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 1.0 | ++-----------+-----------------+ +| *Setter* | set_step(value) | ++-----------+-----------------+ +| *Getter* | get_step() | ++-----------+-----------------+ If greater than 0, ``value`` will always be rounded to a multiple of ``step``. If ``rounded`` is also ``true``, ``value`` will first be rounded to a multiple of ``step`` then rounded to the nearest integer. @@ -187,11 +203,13 @@ If greater than 0, ``value`` will always be rounded to a multiple of ``step``. I - :ref:`float` **value** -+----------+------------------+ -| *Setter* | set_value(value) | -+----------+------------------+ -| *Getter* | get_value() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_value(value) | ++-----------+------------------+ +| *Getter* | get_value() | ++-----------+------------------+ Range's current value. diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 417d903f1..efa121b45 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -19,19 +19,19 @@ Query the closest object intersecting a ray. Properties ---------- -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cast_to` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_areas` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_bodies` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+-------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`exclude_parent` | -+-------------------------------+------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------+---------------------+ +| :ref:`Vector3` | :ref:`cast_to` | Vector3( 0, -1, 0 ) | ++-------------------------------+------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | false | ++-------------------------------+------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | true | ++-------------------------------+------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++-------------------------------+------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`enabled` | false | ++-------------------------------+------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`exclude_parent` | true | ++-------------------------------+------------------------------------------------------------------------+---------------------+ Methods ------- @@ -84,11 +84,13 @@ Property Descriptions - :ref:`Vector3` **cast_to** -+----------+--------------------+ -| *Setter* | set_cast_to(value) | -+----------+--------------------+ -| *Getter* | get_cast_to() | -+----------+--------------------+ ++-----------+---------------------+ +| *Default* | Vector3( 0, -1, 0 ) | ++-----------+---------------------+ +| *Setter* | set_cast_to(value) | ++-----------+---------------------+ +| *Getter* | get_cast_to() | ++-----------+---------------------+ The ray's destination point, relative to the RayCast's ``position``. @@ -96,35 +98,41 @@ The ray's destination point, relative to the RayCast's ``position``. - :ref:`bool` **collide_with_areas** -+----------+---------------------------------+ -| *Setter* | set_collide_with_areas(value) | -+----------+---------------------------------+ -| *Getter* | is_collide_with_areas_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ -If ``true``, collision with :ref:`Area`\ s will be reported. Default value: ``false``. +If ``true``, collision with :ref:`Area`\ s will be reported. .. _class_RayCast_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** -+----------+----------------------------------+ -| *Setter* | set_collide_with_bodies(value) | -+----------+----------------------------------+ -| *Getter* | is_collide_with_bodies_enabled() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ -If ``true``, collision with :ref:`PhysicsBody`\ s will be reported. Default value: ``true``. +If ``true``, collision with :ref:`PhysicsBody`\ s will be reported. .. _class_RayCast_property_collision_mask: - :ref:`int` **collision_mask** -+----------+---------------------------+ -| *Setter* | set_collision_mask(value) | -+----------+---------------------------+ -| *Getter* | get_collision_mask() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_collision_mask() | ++-----------+---------------------------+ The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. @@ -132,25 +140,29 @@ The ray's collision mask. Only objects in at least one collision layer enabled i - :ref:`bool` **enabled** -+----------+--------------------+ -| *Setter* | set_enabled(value) | -+----------+--------------------+ -| *Getter* | is_enabled() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ -If ``true``, collisions will be reported. Default value: ``false``. +If ``true``, collisions will be reported. .. _class_RayCast_property_exclude_parent: - :ref:`bool` **exclude_parent** -+----------+--------------------------------+ -| *Setter* | set_exclude_parent_body(value) | -+----------+--------------------------------+ -| *Getter* | get_exclude_parent_body() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | true | ++-----------+--------------------------------+ +| *Setter* | set_exclude_parent_body(value) | ++-----------+--------------------------------+ +| *Getter* | get_exclude_parent_body() | ++-----------+--------------------------------+ -If ``true``, collisions will be ignored for this RayCast's immediate parent. Default value: ``true``. +If ``true``, collisions will be ignored for this RayCast's immediate parent. Method Descriptions ------------------- diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index fa1d95858..a6d6e9ddb 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -19,19 +19,19 @@ Query the closest object intersecting a ray. Properties ---------- -+-------------------------------+--------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cast_to` | -+-------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_areas` | -+-------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_bodies` | -+-------------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+-------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`exclude_parent` | -+-------------------------------+--------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------+------------------+ +| :ref:`Vector2` | :ref:`cast_to` | Vector2( 0, 50 ) | ++-------------------------------+--------------------------------------------------------------------------+------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | false | ++-------------------------------+--------------------------------------------------------------------------+------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | true | ++-------------------------------+--------------------------------------------------------------------------+------------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++-------------------------------+--------------------------------------------------------------------------+------------------+ +| :ref:`bool` | :ref:`enabled` | false | ++-------------------------------+--------------------------------------------------------------------------+------------------+ +| :ref:`bool` | :ref:`exclude_parent` | true | ++-------------------------------+--------------------------------------------------------------------------+------------------+ Methods ------- @@ -84,11 +84,13 @@ Property Descriptions - :ref:`Vector2` **cast_to** -+----------+--------------------+ -| *Setter* | set_cast_to(value) | -+----------+--------------------+ -| *Getter* | get_cast_to() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | Vector2( 0, 50 ) | ++-----------+--------------------+ +| *Setter* | set_cast_to(value) | ++-----------+--------------------+ +| *Getter* | get_cast_to() | ++-----------+--------------------+ The ray's destination point, relative to the RayCast's ``position``. @@ -96,35 +98,41 @@ The ray's destination point, relative to the RayCast's ``position``. - :ref:`bool` **collide_with_areas** -+----------+---------------------------------+ -| *Setter* | set_collide_with_areas(value) | -+----------+---------------------------------+ -| *Getter* | is_collide_with_areas_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++-----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++-----------+---------------------------------+ -If ``true``, collision with :ref:`Area2D`\ s will be reported. Default value: ``false``. +If ``true``, collision with :ref:`Area2D`\ s will be reported. .. _class_RayCast2D_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** -+----------+----------------------------------+ -| *Setter* | set_collide_with_bodies(value) | -+----------+----------------------------------+ -| *Getter* | is_collide_with_bodies_enabled() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | true | ++-----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++-----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++-----------+----------------------------------+ -If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. Default value: ``true``. +If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. .. _class_RayCast2D_property_collision_mask: - :ref:`int` **collision_mask** -+----------+---------------------------+ -| *Setter* | set_collision_mask(value) | -+----------+---------------------------+ -| *Getter* | get_collision_mask() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_collision_mask() | ++-----------+---------------------------+ The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. @@ -132,25 +140,29 @@ The ray's collision mask. Only objects in at least one collision layer enabled i - :ref:`bool` **enabled** -+----------+--------------------+ -| *Setter* | set_enabled(value) | -+----------+--------------------+ -| *Getter* | is_enabled() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ -If ``true``, collisions will be reported. Default value: ``false``. +If ``true``, collisions will be reported. .. _class_RayCast2D_property_exclude_parent: - :ref:`bool` **exclude_parent** -+----------+--------------------------------+ -| *Setter* | set_exclude_parent_body(value) | -+----------+--------------------------------+ -| *Getter* | get_exclude_parent_body() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | true | ++-----------+--------------------------------+ +| *Setter* | set_exclude_parent_body(value) | ++-----------+--------------------------------+ +| *Getter* | get_exclude_parent_body() | ++-----------+--------------------------------+ -If ``true``, the parent node will be excluded from collision detection. Default value: ``true``. +If ``true``, the parent node will be excluded from collision detection. Method Descriptions ------------------- diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index cd3535712..6d75ba3f3 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -19,11 +19,11 @@ Ray shape for 3D collisions. Properties ---------- -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`slips_on_slope` | -+---------------------------+---------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`length` | 1.0 | ++---------------------------+---------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`slips_on_slope` | false | ++---------------------------+---------------------------------------------------------------+-------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`float` **length** -+----------+-------------------+ -| *Setter* | set_length(value) | -+----------+-------------------+ -| *Getter* | get_length() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_length(value) | ++-----------+-------------------+ +| *Getter* | get_length() | ++-----------+-------------------+ The ray's length. @@ -49,11 +51,13 @@ The ray's length. - :ref:`bool` **slips_on_slope** -+----------+---------------------------+ -| *Setter* | set_slips_on_slope(value) | -+----------+---------------------------+ -| *Getter* | get_slips_on_slope() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_slips_on_slope(value) | ++-----------+---------------------------+ +| *Getter* | get_slips_on_slope() | ++-----------+---------------------------+ -If ``true``, allow the shape to return the correct normal. Default value: ``false``. +If ``true``, allow the shape to return the correct normal. diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 5683ae1b8..5b0924c73 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -19,11 +19,11 @@ Ray shape for 2D collisions. Properties ---------- -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`slips_on_slope` | -+---------------------------+-----------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`length` | 20.0 | ++---------------------------+-----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`slips_on_slope` | false | ++---------------------------+-----------------------------------------------------------------+-------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`float` **length** -+----------+-------------------+ -| *Setter* | set_length(value) | -+----------+-------------------+ -| *Getter* | get_length() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 20.0 | ++-----------+-------------------+ +| *Setter* | set_length(value) | ++-----------+-------------------+ +| *Getter* | get_length() | ++-----------+-------------------+ The ray's length. @@ -49,11 +51,13 @@ The ray's length. - :ref:`bool` **slips_on_slope** -+----------+---------------------------+ -| *Setter* | set_slips_on_slope(value) | -+----------+---------------------------+ -| *Getter* | get_slips_on_slope() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_slips_on_slope(value) | ++-----------+---------------------------+ +| *Getter* | get_slips_on_slope() | ++-----------+---------------------------+ -If ``true``, allow the shape to return the correct normal. Default value: ``false``. +If ``true``, allow the shape to return the correct normal. diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 43d408512..13564542d 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -17,13 +17,13 @@ Brief Description Properties ---------- -+-------------------------------+------------------------------------------------+ -| :ref:`Vector2` | :ref:`end` | -+-------------------------------+------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+------------------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+-------------------------------+------------------------------------------------+ ++-------------------------------+------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`end` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`position` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`size` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------+-----------------+ Methods ------- @@ -75,18 +75,30 @@ Property Descriptions - :ref:`Vector2` **end** ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ + Ending corner. .. _class_Rect2_property_position: - :ref:`Vector2` **position** ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ + Position (starting corner). .. _class_Rect2_property_size: - :ref:`Vector2` **size** ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ + Size from position to end. Method Descriptions diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 4751de2d9..367b6720c 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -19,9 +19,9 @@ Rectangle shape for 2D collisions. Properties ---------- -+-------------------------------+---------------------------------------------------------+ -| :ref:`Vector2` | :ref:`extents` | -+-------------------------------+---------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`extents` | Vector2( 10, 10 ) | ++-------------------------------+---------------------------------------------------------+-------------------+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`Vector2` **extents** -+----------+--------------------+ -| *Setter* | set_extents(value) | -+----------+--------------------+ -| *Getter* | get_extents() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | Vector2( 10, 10 ) | ++-----------+--------------------+ +| *Setter* | set_extents(value) | ++-----------+--------------------+ +| *Getter* | get_extents() | ++-----------+--------------------+ The rectangle's half extents. The width and height of this shape is twice the half extents. diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 57af07d9c..884882a05 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -19,14 +19,16 @@ Reference frame for GUI. Properties ---------- -+---------------------------+----------------------------------------------------------------+ -| :ref:`Color` | :ref:`border_color` | -+---------------------------+----------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`border_color` | Color( 1, 0, 0, 1 ) | ++---------------------------+----------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`editor_only` | true | ++---------------------------+----------------------------------------------------------------+---------------------+ Description ----------- -Reference frame for GUI. It's just like an empty control, except an outline border :ref:`border_color` is displayed while editing around its size at all times. +A rectangle box that displays only a :ref:`border_color` border color around its rectangle. ``ReferenceRect`` has no fill :ref:`Color`. Property Descriptions --------------------- @@ -35,11 +37,27 @@ Property Descriptions - :ref:`Color` **border_color** -+----------+-------------------------+ -| *Setter* | set_border_color(value) | -+----------+-------------------------+ -| *Getter* | get_border_color() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Color( 1, 0, 0, 1 ) | ++-----------+-------------------------+ +| *Setter* | set_border_color(value) | ++-----------+-------------------------+ +| *Getter* | get_border_color() | ++-----------+-------------------------+ -Determines the border :ref:`Color` of the ``ReferenceRect``. +Sets the border :ref:`Color` of the ``ReferenceRect``. + +.. _class_ReferenceRect_property_editor_only: + +- :ref:`bool` **editor_only** + ++-----------+------------------------+ +| *Default* | true | ++-----------+------------------------+ +| *Setter* | set_editor_only(value) | ++-----------+------------------------+ +| *Getter* | get_editor_only() | ++-----------+------------------------+ + +If set to ``true``, the ``ReferenceRect`` will only be visible while in editor. Otherwise, ``ReferenceRect`` will be visible in game. diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index fd0c96b38..5ee410b5d 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -19,31 +19,31 @@ Brief Description Properties ---------- -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`box_projection` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cull_mask` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`enable_shadows` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`extents` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`intensity` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interior_ambient_color` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interior_ambient_contrib` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interior_ambient_energy` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interior_enable` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max_distance` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`origin_offset` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`UpdateMode` | :ref:`update_mode` | -+----------------------------------------------------+------------------------------------------------------------------------------------------+ ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`box_projection` | false | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`cull_mask` | 1048575 | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`enable_shadows` | false | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector3` | :ref:`extents` | Vector3( 1, 1, 1 ) | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`intensity` | 1.0 | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`interior_ambient_color` | Color( 0, 0, 0, 1 ) | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`interior_ambient_contrib` | 0.0 | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`interior_ambient_energy` | 1.0 | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`interior_enable` | false | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`max_distance` | 0.0 | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector3` | :ref:`origin_offset` | Vector3( 0, 0, 0 ) | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ +| :ref:`UpdateMode` | :ref:`update_mode` | 0 | ++----------------------------------------------------+------------------------------------------------------------------------------------------+---------------------+ Enumerations ------------ @@ -72,119 +72,143 @@ Property Descriptions - :ref:`bool` **box_projection** -+----------+----------------------------------+ -| *Setter* | set_enable_box_projection(value) | -+----------+----------------------------------+ -| *Getter* | is_box_projection_enabled() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_enable_box_projection(value) | ++-----------+----------------------------------+ +| *Getter* | is_box_projection_enabled() | ++-----------+----------------------------------+ .. _class_ReflectionProbe_property_cull_mask: - :ref:`int` **cull_mask** -+----------+----------------------+ -| *Setter* | set_cull_mask(value) | -+----------+----------------------+ -| *Getter* | get_cull_mask() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1048575 | ++-----------+----------------------+ +| *Setter* | set_cull_mask(value) | ++-----------+----------------------+ +| *Getter* | get_cull_mask() | ++-----------+----------------------+ .. _class_ReflectionProbe_property_enable_shadows: - :ref:`bool` **enable_shadows** -+----------+---------------------------+ -| *Setter* | set_enable_shadows(value) | -+----------+---------------------------+ -| *Getter* | are_shadows_enabled() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_enable_shadows(value) | ++-----------+---------------------------+ +| *Getter* | are_shadows_enabled() | ++-----------+---------------------------+ .. _class_ReflectionProbe_property_extents: - :ref:`Vector3` **extents** -+----------+--------------------+ -| *Setter* | set_extents(value) | -+----------+--------------------+ -| *Getter* | get_extents() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | Vector3( 1, 1, 1 ) | ++-----------+--------------------+ +| *Setter* | set_extents(value) | ++-----------+--------------------+ +| *Getter* | get_extents() | ++-----------+--------------------+ .. _class_ReflectionProbe_property_intensity: - :ref:`float` **intensity** -+----------+----------------------+ -| *Setter* | set_intensity(value) | -+----------+----------------------+ -| *Getter* | get_intensity() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1.0 | ++-----------+----------------------+ +| *Setter* | set_intensity(value) | ++-----------+----------------------+ +| *Getter* | get_intensity() | ++-----------+----------------------+ .. _class_ReflectionProbe_property_interior_ambient_color: - :ref:`Color` **interior_ambient_color** -+----------+-----------------------------+ -| *Setter* | set_interior_ambient(value) | -+----------+-----------------------------+ -| *Getter* | get_interior_ambient() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | Color( 0, 0, 0, 1 ) | ++-----------+-----------------------------+ +| *Setter* | set_interior_ambient(value) | ++-----------+-----------------------------+ +| *Getter* | get_interior_ambient() | ++-----------+-----------------------------+ .. _class_ReflectionProbe_property_interior_ambient_contrib: - :ref:`float` **interior_ambient_contrib** -+----------+------------------------------------------------+ -| *Setter* | set_interior_ambient_probe_contribution(value) | -+----------+------------------------------------------------+ -| *Getter* | get_interior_ambient_probe_contribution() | -+----------+------------------------------------------------+ ++-----------+------------------------------------------------+ +| *Default* | 0.0 | ++-----------+------------------------------------------------+ +| *Setter* | set_interior_ambient_probe_contribution(value) | ++-----------+------------------------------------------------+ +| *Getter* | get_interior_ambient_probe_contribution() | ++-----------+------------------------------------------------+ .. _class_ReflectionProbe_property_interior_ambient_energy: - :ref:`float` **interior_ambient_energy** -+----------+------------------------------------+ -| *Setter* | set_interior_ambient_energy(value) | -+----------+------------------------------------+ -| *Getter* | get_interior_ambient_energy() | -+----------+------------------------------------+ ++-----------+------------------------------------+ +| *Default* | 1.0 | ++-----------+------------------------------------+ +| *Setter* | set_interior_ambient_energy(value) | ++-----------+------------------------------------+ +| *Getter* | get_interior_ambient_energy() | ++-----------+------------------------------------+ .. _class_ReflectionProbe_property_interior_enable: - :ref:`bool` **interior_enable** -+----------+------------------------+ -| *Setter* | set_as_interior(value) | -+----------+------------------------+ -| *Getter* | is_set_as_interior() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_as_interior(value) | ++-----------+------------------------+ +| *Getter* | is_set_as_interior() | ++-----------+------------------------+ .. _class_ReflectionProbe_property_max_distance: - :ref:`float` **max_distance** -+----------+-------------------------+ -| *Setter* | set_max_distance(value) | -+----------+-------------------------+ -| *Getter* | get_max_distance() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------+ +| *Setter* | set_max_distance(value) | ++-----------+-------------------------+ +| *Getter* | get_max_distance() | ++-----------+-------------------------+ .. _class_ReflectionProbe_property_origin_offset: - :ref:`Vector3` **origin_offset** -+----------+--------------------------+ -| *Setter* | set_origin_offset(value) | -+----------+--------------------------+ -| *Getter* | get_origin_offset() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------------+ +| *Setter* | set_origin_offset(value) | ++-----------+--------------------------+ +| *Getter* | get_origin_offset() | ++-----------+--------------------------+ .. _class_ReflectionProbe_property_update_mode: - :ref:`UpdateMode` **update_mode** -+----------+------------------------+ -| *Setter* | set_update_mode(value) | -+----------+------------------------+ -| *Getter* | get_update_mode() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_update_mode(value) | ++-----------+------------------------+ +| *Getter* | get_update_mode() | ++-----------+------------------------+ diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index d18df0acc..1994b60e4 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -19,13 +19,13 @@ Contains the results of a :ref:`RegEx` search. Properties ---------- -+-------------------------------------+---------------------------------------------------+ -| :ref:`Dictionary` | :ref:`names` | -+-------------------------------------+---------------------------------------------------+ -| :ref:`Array` | :ref:`strings` | -+-------------------------------------+---------------------------------------------------+ -| :ref:`String` | :ref:`subject` | -+-------------------------------------+---------------------------------------------------+ ++-------------------------------------+---------------------------------------------------+------+ +| :ref:`Dictionary` | :ref:`names` | { } | ++-------------------------------------+---------------------------------------------------+------+ +| :ref:`Array` | :ref:`strings` | [ ] | ++-------------------------------------+---------------------------------------------------+------+ +| :ref:`String` | :ref:`subject` | "" | ++-------------------------------------+---------------------------------------------------+------+ Methods ------- @@ -52,9 +52,11 @@ Property Descriptions - :ref:`Dictionary` **names** -+----------+-------------+ -| *Getter* | get_names() | -+----------+-------------+ ++-----------+-------------+ +| *Default* | { } | ++-----------+-------------+ +| *Getter* | get_names() | ++-----------+-------------+ A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. @@ -62,9 +64,11 @@ A dictionary of named groups and its corresponding group number. Only groups wit - :ref:`Array` **strings** -+----------+---------------+ -| *Getter* | get_strings() | -+----------+---------------+ ++-----------+---------------+ +| *Default* | [ ] | ++-----------+---------------+ +| *Getter* | get_strings() | ++-----------+---------------+ An :ref:`Array` of the match and its capturing groups. @@ -72,9 +76,11 @@ An :ref:`Array` of the match and its capturing groups. - :ref:`String` **subject** -+----------+---------------+ -| *Getter* | get_subject() | -+----------+---------------+ ++-----------+---------------+ +| *Default* | "" | ++-----------+---------------+ +| *Getter* | get_subject() | ++-----------+---------------+ The source string used with the search pattern to find this matching result. diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 0519fb8c1..aee7b50b9 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -19,17 +19,17 @@ RemoteTransform pushes its own :ref:`Transform` to another :ref Properties ---------- -+---------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`remote_path` | -+---------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_position` | -+---------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_rotation` | -+---------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_scale` | -+---------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_global_coordinates` | -+---------------------------------+--------------------------------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`remote_path` | NodePath("") | ++---------------------------------+--------------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`update_position` | true | ++---------------------------------+--------------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`update_rotation` | true | ++---------------------------------+--------------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`update_scale` | true | ++---------------------------------+--------------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`use_global_coordinates` | true | ++---------------------------------+--------------------------------------------------------------------------------------+--------------+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`NodePath` **remote_path** -+----------+------------------------+ -| *Setter* | set_remote_node(value) | -+----------+------------------------+ -| *Getter* | get_remote_node() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | NodePath("") | ++-----------+------------------------+ +| *Setter* | set_remote_node(value) | ++-----------+------------------------+ +| *Getter* | get_remote_node() | ++-----------+------------------------+ The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. @@ -57,47 +59,55 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr - :ref:`bool` **update_position** -+----------+----------------------------+ -| *Setter* | set_update_position(value) | -+----------+----------------------------+ -| *Getter* | get_update_position() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | true | ++-----------+----------------------------+ +| *Setter* | set_update_position(value) | ++-----------+----------------------------+ +| *Getter* | get_update_position() | ++-----------+----------------------------+ -If ``true``, the remote node's position is updated. Default value: ``true``. +If ``true``, the remote node's position is updated. .. _class_RemoteTransform_property_update_rotation: - :ref:`bool` **update_rotation** -+----------+----------------------------+ -| *Setter* | set_update_rotation(value) | -+----------+----------------------------+ -| *Getter* | get_update_rotation() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | true | ++-----------+----------------------------+ +| *Setter* | set_update_rotation(value) | ++-----------+----------------------------+ +| *Getter* | get_update_rotation() | ++-----------+----------------------------+ -If ``true``, the remote node's rotation is updated. Default value: ``true``. +If ``true``, the remote node's rotation is updated. .. _class_RemoteTransform_property_update_scale: - :ref:`bool` **update_scale** -+----------+-------------------------+ -| *Setter* | set_update_scale(value) | -+----------+-------------------------+ -| *Getter* | get_update_scale() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | true | ++-----------+-------------------------+ +| *Setter* | set_update_scale(value) | ++-----------+-------------------------+ +| *Getter* | get_update_scale() | ++-----------+-------------------------+ -If ``true``, the remote node's scale is updated. Default value: ``true``. +If ``true``, the remote node's scale is updated. .. _class_RemoteTransform_property_use_global_coordinates: - :ref:`bool` **use_global_coordinates** -+----------+-----------------------------------+ -| *Setter* | set_use_global_coordinates(value) | -+----------+-----------------------------------+ -| *Getter* | get_use_global_coordinates() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | true | ++-----------+-----------------------------------+ +| *Setter* | set_use_global_coordinates(value) | ++-----------+-----------------------------------+ +| *Getter* | get_use_global_coordinates() | ++-----------+-----------------------------------+ -If ``true``, global coordinates are used. If ``false``, local coordinates are used. Default value: ``true``. +If ``true``, global coordinates are used. If ``false``, local coordinates are used. diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 86bb44ed4..63eb7264e 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -19,17 +19,17 @@ RemoteTransform2D pushes its own :ref:`Transform2D` to anothe Properties ---------- -+---------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`remote_path` | -+---------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_position` | -+---------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_rotation` | -+---------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_scale` | -+---------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_global_coordinates` | -+---------------------------------+----------------------------------------------------------------------------------------+ ++---------------------------------+----------------------------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`remote_path` | NodePath("") | ++---------------------------------+----------------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`update_position` | true | ++---------------------------------+----------------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`update_rotation` | true | ++---------------------------------+----------------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`update_scale` | true | ++---------------------------------+----------------------------------------------------------------------------------------+--------------+ +| :ref:`bool` | :ref:`use_global_coordinates` | true | ++---------------------------------+----------------------------------------------------------------------------------------+--------------+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`NodePath` **remote_path** -+----------+------------------------+ -| *Setter* | set_remote_node(value) | -+----------+------------------------+ -| *Getter* | get_remote_node() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | NodePath("") | ++-----------+------------------------+ +| *Setter* | set_remote_node(value) | ++-----------+------------------------+ +| *Getter* | get_remote_node() | ++-----------+------------------------+ The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. @@ -57,47 +59,55 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr - :ref:`bool` **update_position** -+----------+----------------------------+ -| *Setter* | set_update_position(value) | -+----------+----------------------------+ -| *Getter* | get_update_position() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | true | ++-----------+----------------------------+ +| *Setter* | set_update_position(value) | ++-----------+----------------------------+ +| *Getter* | get_update_position() | ++-----------+----------------------------+ -If ``true``, the remote node's position is updated. Default value: ``true``. +If ``true``, the remote node's position is updated. .. _class_RemoteTransform2D_property_update_rotation: - :ref:`bool` **update_rotation** -+----------+----------------------------+ -| *Setter* | set_update_rotation(value) | -+----------+----------------------------+ -| *Getter* | get_update_rotation() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | true | ++-----------+----------------------------+ +| *Setter* | set_update_rotation(value) | ++-----------+----------------------------+ +| *Getter* | get_update_rotation() | ++-----------+----------------------------+ -If ``true``, the remote node's rotation is updated. Default value: ``true``. +If ``true``, the remote node's rotation is updated. .. _class_RemoteTransform2D_property_update_scale: - :ref:`bool` **update_scale** -+----------+-------------------------+ -| *Setter* | set_update_scale(value) | -+----------+-------------------------+ -| *Getter* | get_update_scale() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | true | ++-----------+-------------------------+ +| *Setter* | set_update_scale(value) | ++-----------+-------------------------+ +| *Getter* | get_update_scale() | ++-----------+-------------------------+ -If ``true``, the remote node's scale is updated. Default value: ``true``. +If ``true``, the remote node's scale is updated. .. _class_RemoteTransform2D_property_use_global_coordinates: - :ref:`bool` **use_global_coordinates** -+----------+-----------------------------------+ -| *Setter* | set_use_global_coordinates(value) | -+----------+-----------------------------------+ -| *Getter* | get_use_global_coordinates() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | true | ++-----------+-----------------------------------+ +| *Setter* | set_use_global_coordinates(value) | ++-----------+-----------------------------------+ +| *Getter* | get_use_global_coordinates() | ++-----------+-----------------------------------+ -If ``true``, global coordinates are used. If ``false``, local coordinates are used. Default value: ``true``. +If ``true``, global coordinates are used. If ``false``, local coordinates are used. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 7dadf740c..868a6392e 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -21,13 +21,13 @@ Base class for all resources. Properties ---------- -+-----------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resource_local_to_scene` | -+-----------------------------+---------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resource_name` | -+-----------------------------+---------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resource_path` | -+-----------------------------+---------------------------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`resource_local_to_scene` | false | ++-----------------------------+---------------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`resource_name` | "" | ++-----------------------------+---------------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`resource_path` | "" | ++-----------------------------+---------------------------------------------------------------------------------+-------+ Methods ------- @@ -72,11 +72,13 @@ Property Descriptions - :ref:`bool` **resource_local_to_scene** -+----------+---------------------------+ -| *Setter* | set_local_to_scene(value) | -+----------+---------------------------+ -| *Getter* | is_local_to_scene() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_local_to_scene(value) | ++-----------+---------------------------+ +| *Getter* | is_local_to_scene() | ++-----------+---------------------------+ If ``true``, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene. @@ -84,11 +86,13 @@ If ``true``, the resource will be made unique in each instance of its local scen - :ref:`String` **resource_name** -+----------+-----------------+ -| *Setter* | set_name(value) | -+----------+-----------------+ -| *Getter* | get_name() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | set_name(value) | ++-----------+-----------------+ +| *Getter* | get_name() | ++-----------+-----------------+ The name of the resource. This is an optional identifier. @@ -96,11 +100,13 @@ The name of the resource. This is an optional identifier. - :ref:`String` **resource_path** -+----------+-----------------+ -| *Setter* | set_path(value) | -+----------+-----------------+ -| *Getter* | get_path() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | set_path(value) | ++-----------+-----------------+ +| *Getter* | get_path() | ++-----------+-----------------+ The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index d40424b90..0b98fbe2c 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -19,29 +19,29 @@ Label that displays rich text. Properties ---------- -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bbcode_enabled` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`bbcode_text` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`meta_underlined` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`override_selected_font_color` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`percent_visible` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_active` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_following` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`selection_enabled` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tab_size` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+-----------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`visible_characters` | -+-----------------------------+------------------------------------------------------------------------------------------------+ ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`bbcode_enabled` | false | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`bbcode_text` | "" | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`meta_underlined` | true | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`override_selected_font_color` | false | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`percent_visible` | 1.0 | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`scroll_active` | true | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`scroll_following` | false | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`selection_enabled` | false | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`tab_size` | 4 | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`text` | "" | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`visible_characters` | -1 | ++-----------------------------+------------------------------------------------------------------------------------------------+-------+ Methods ------- @@ -101,41 +101,41 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`Font` | bold_font | -+---------------------------------+---------------------+ -| :ref:`Font` | bold_italics_font | -+---------------------------------+---------------------+ -| :ref:`Color` | default_color | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_selected | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_shadow | -+---------------------------------+---------------------+ -| :ref:`Font` | italics_font | -+---------------------------------+---------------------+ -| :ref:`int` | line_separation | -+---------------------------------+---------------------+ -| :ref:`Font` | mono_font | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+---------------------+ -| :ref:`Font` | normal_font | -+---------------------------------+---------------------+ -| :ref:`Color` | selection_color | -+---------------------------------+---------------------+ -| :ref:`int` | shadow_as_outline | -+---------------------------------+---------------------+ -| :ref:`int` | shadow_offset_x | -+---------------------------------+---------------------+ -| :ref:`int` | shadow_offset_y | -+---------------------------------+---------------------+ -| :ref:`int` | table_hseparation | -+---------------------------------+---------------------+ -| :ref:`int` | table_vseparation | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | bold_font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | bold_italics_font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | default_color | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_selected | Color( 0.490196, 0.490196, 0.490196, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_shadow | Color( 0, 0, 0, 0 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | italics_font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | line_separation | 1 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | mono_font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | normal_font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | selection_color | Color( 0.1, 0.1, 1, 0.8 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | shadow_as_outline | 0 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | shadow_offset_x | 1 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | shadow_offset_y | 1 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | table_hseparation | 3 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | table_vseparation | 3 | ++---------------------------------+---------------------+------------------------------------------+ Signals ------- @@ -272,23 +272,27 @@ Property Descriptions - :ref:`bool` **bbcode_enabled** -+----------+-----------------------+ -| *Setter* | set_use_bbcode(value) | -+----------+-----------------------+ -| *Getter* | is_using_bbcode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | false | ++-----------+-----------------------+ +| *Setter* | set_use_bbcode(value) | ++-----------+-----------------------+ +| *Getter* | is_using_bbcode() | ++-----------+-----------------------+ -If ``true``, the label uses BBCode formatting. Default value: ``false``. +If ``true``, the label uses BBCode formatting. .. _class_RichTextLabel_property_bbcode_text: - :ref:`String` **bbcode_text** -+----------+-------------------+ -| *Setter* | set_bbcode(value) | -+----------+-------------------+ -| *Getter* | get_bbcode() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | "" | ++-----------+-------------------+ +| *Setter* | set_bbcode(value) | ++-----------+-------------------+ +| *Getter* | get_bbcode() | ++-----------+-------------------+ The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. @@ -296,35 +300,41 @@ The label's text in BBCode format. Is not representative of manual modifications - :ref:`bool` **meta_underlined** -+----------+---------------------------+ -| *Setter* | set_meta_underline(value) | -+----------+---------------------------+ -| *Getter* | is_meta_underlined() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | true | ++-----------+---------------------------+ +| *Setter* | set_meta_underline(value) | ++-----------+---------------------------+ +| *Getter* | is_meta_underlined() | ++-----------+---------------------------+ -If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. Default value: ``true``. +If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. .. _class_RichTextLabel_property_override_selected_font_color: - :ref:`bool` **override_selected_font_color** -+----------+-----------------------------------------+ -| *Setter* | set_override_selected_font_color(value) | -+----------+-----------------------------------------+ -| *Getter* | is_overriding_selected_font_color() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | false | ++-----------+-----------------------------------------+ +| *Setter* | set_override_selected_font_color(value) | ++-----------+-----------------------------------------+ +| *Getter* | is_overriding_selected_font_color() | ++-----------+-----------------------------------------+ -If ``true``, the label uses the custom font color. Default value: ``false``. +If ``true``, the label uses the custom font color. .. _class_RichTextLabel_property_percent_visible: - :ref:`float` **percent_visible** -+----------+----------------------------+ -| *Setter* | set_percent_visible(value) | -+----------+----------------------------+ -| *Getter* | get_percent_visible() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1.0 | ++-----------+----------------------------+ +| *Setter* | set_percent_visible(value) | ++-----------+----------------------------+ +| *Getter* | get_percent_visible() | ++-----------+----------------------------+ The text's visibility, as a :ref:`float` between 0.0 and 1.0. @@ -332,35 +342,41 @@ The text's visibility, as a :ref:`float` between 0.0 and 1.0. - :ref:`bool` **scroll_active** -+----------+--------------------------+ -| *Setter* | set_scroll_active(value) | -+----------+--------------------------+ -| *Getter* | is_scroll_active() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | true | ++-----------+--------------------------+ +| *Setter* | set_scroll_active(value) | ++-----------+--------------------------+ +| *Getter* | is_scroll_active() | ++-----------+--------------------------+ -If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. +If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. .. _class_RichTextLabel_property_scroll_following: - :ref:`bool` **scroll_following** -+----------+--------------------------+ -| *Setter* | set_scroll_follow(value) | -+----------+--------------------------+ -| *Getter* | is_scroll_following() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_scroll_follow(value) | ++-----------+--------------------------+ +| *Getter* | is_scroll_following() | ++-----------+--------------------------+ -If ``true``, the window scrolls down to display new content automatically. Default value: ``false``. +If ``true``, the window scrolls down to display new content automatically. .. _class_RichTextLabel_property_selection_enabled: - :ref:`bool` **selection_enabled** -+----------+------------------------------+ -| *Setter* | set_selection_enabled(value) | -+----------+------------------------------+ -| *Getter* | is_selection_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_selection_enabled(value) | ++-----------+------------------------------+ +| *Getter* | is_selection_enabled() | ++-----------+------------------------------+ If ``true``, the label allows text selection. @@ -368,11 +384,13 @@ If ``true``, the label allows text selection. - :ref:`int` **tab_size** -+----------+---------------------+ -| *Setter* | set_tab_size(value) | -+----------+---------------------+ -| *Getter* | get_tab_size() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 4 | ++-----------+---------------------+ +| *Setter* | set_tab_size(value) | ++-----------+---------------------+ +| *Getter* | get_tab_size() | ++-----------+---------------------+ The number of spaces associated with a single tab length. Does not affect ``\t`` in text tags, only indent tags. @@ -380,11 +398,13 @@ The number of spaces associated with a single tab length. Does not affect ``\t`` - :ref:`String` **text** -+----------+-----------------+ -| *Setter* | set_text(value) | -+----------+-----------------+ -| *Getter* | get_text() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | set_text(value) | ++-----------+-----------------+ +| *Getter* | get_text() | ++-----------+-----------------+ The raw text of the label. @@ -394,11 +414,13 @@ When set, clears the tag stack and adds a raw text tag to the top of it. Does no - :ref:`int` **visible_characters** -+----------+-------------------------------+ -| *Setter* | set_visible_characters(value) | -+----------+-------------------------------+ -| *Getter* | get_visible_characters() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | -1 | ++-----------+-------------------------------+ +| *Setter* | set_visible_characters(value) | ++-----------+-------------------------------+ +| *Getter* | get_visible_characters() | ++-----------+-------------------------------+ The restricted number of characters to display in the label. If ``-1``, all characters will be displayed. diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index d312376f4..98ea52398 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -21,53 +21,53 @@ Physics Body whose position is determined through physics simulation in 3D space Properties ---------- -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`angular_velocity` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_angular_x` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_angular_y` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_angular_z` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_linear_x` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_linear_y` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_linear_z` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_sleep` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`contact_monitor` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`contacts_reported` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`continuous_cd` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`custom_integrator` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_scale` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`linear_velocity` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mass` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sleeping` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`weight` | -+-----------------------------------------------+--------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`angular_damp` | -1.0 | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`angular_velocity` | Vector3( 0, 0, 0 ) | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`axis_lock_angular_x` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`axis_lock_angular_y` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`axis_lock_angular_z` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`axis_lock_linear_x` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`axis_lock_linear_y` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`axis_lock_linear_z` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`bounce` | | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`can_sleep` | true | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`contact_monitor` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`contacts_reported` | 0 | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`continuous_cd` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`custom_integrator` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`friction` | | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`gravity_scale` | 1.0 | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`linear_damp` | -1.0 | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`linear_velocity` | Vector3( 0, 0, 0 ) | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`mass` | 1.0 | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`Mode` | :ref:`mode` | 0 | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | null | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`sleeping` | false | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`weight` | 9.8 | ++-----------------------------------------------+--------------------------------------------------------------------------------------+--------------------+ Methods ------- @@ -175,11 +175,13 @@ Property Descriptions - :ref:`float` **angular_damp** -+----------+-------------------------+ -| *Setter* | set_angular_damp(value) | -+----------+-------------------------+ -| *Getter* | get_angular_damp() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | -1.0 | ++-----------+-------------------------+ +| *Setter* | set_angular_damp(value) | ++-----------+-------------------------+ +| *Getter* | get_angular_damp() | ++-----------+-------------------------+ Damps RigidBody's rotational forces. @@ -187,11 +189,13 @@ Damps RigidBody's rotational forces. - :ref:`Vector3` **angular_velocity** -+----------+-----------------------------+ -| *Setter* | set_angular_velocity(value) | -+----------+-----------------------------+ -| *Getter* | get_angular_velocity() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++-----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++-----------+-----------------------------+ RigidBody's rotational velocity. @@ -199,11 +203,13 @@ RigidBody's rotational velocity. - :ref:`bool` **axis_lock_angular_x** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's rotation in the X axis. @@ -211,11 +217,13 @@ Lock the body's rotation in the X axis. - :ref:`bool` **axis_lock_angular_y** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's rotation in the Y axis. @@ -223,11 +231,13 @@ Lock the body's rotation in the Y axis. - :ref:`bool` **axis_lock_angular_z** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's rotation in the Z axis. @@ -235,11 +245,13 @@ Lock the body's rotation in the Z axis. - :ref:`bool` **axis_lock_linear_x** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's movement in the X axis. @@ -247,11 +259,13 @@ Lock the body's movement in the X axis. - :ref:`bool` **axis_lock_linear_y** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's movement in the Y axis. @@ -259,11 +273,13 @@ Lock the body's movement in the Y axis. - :ref:`bool` **axis_lock_linear_z** -+----------+----------------------+ -| *Setter* | set_axis_lock(value) | -+----------+----------------------+ -| *Getter* | get_axis_lock() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++-----------+----------------------+ +| *Getter* | get_axis_lock() | ++-----------+----------------------+ Lock the body's movement in the Z axis. @@ -277,17 +293,21 @@ Lock the body's movement in the Z axis. | *Getter* | get_bounce() | +----------+-------------------+ -RigidBody's bounciness. +The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). + +Deprecated, use :ref:`PhysicsMaterial.bounce` instead via :ref:`physics_material_override`. .. _class_RigidBody_property_can_sleep: - :ref:`bool` **can_sleep** -+----------+----------------------+ -| *Setter* | set_can_sleep(value) | -+----------+----------------------+ -| *Getter* | is_able_to_sleep() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_can_sleep(value) | ++-----------+----------------------+ +| *Getter* | is_able_to_sleep() | ++-----------+----------------------+ If ``true``, the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the ``apply_impulse`` method is used. @@ -295,11 +315,13 @@ If ``true``, the RigidBody will not calculate forces and will act as a static bo - :ref:`bool` **contact_monitor** -+----------+------------------------------+ -| *Setter* | set_contact_monitor(value) | -+----------+------------------------------+ -| *Getter* | is_contact_monitor_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_contact_monitor(value) | ++-----------+------------------------------+ +| *Getter* | is_contact_monitor_enabled() | ++-----------+------------------------------+ If ``true``, the RigidBody will emit signals when it collides with another RigidBody. @@ -307,11 +329,13 @@ If ``true``, the RigidBody will emit signals when it collides with another Rigid - :ref:`int` **contacts_reported** -+----------+----------------------------------+ -| *Setter* | set_max_contacts_reported(value) | -+----------+----------------------------------+ -| *Getter* | get_max_contacts_reported() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 0 | ++-----------+----------------------------------+ +| *Setter* | set_max_contacts_reported(value) | ++-----------+----------------------------------+ +| *Getter* | get_max_contacts_reported() | ++-----------+----------------------------------+ The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. @@ -319,11 +343,13 @@ The maximum contacts to report. Bodies can keep a log of the contacts with other - :ref:`bool` **continuous_cd** -+----------+-----------------------------------------------+ -| *Setter* | set_use_continuous_collision_detection(value) | -+----------+-----------------------------------------------+ -| *Getter* | is_using_continuous_collision_detection() | -+----------+-----------------------------------------------+ ++-----------+-----------------------------------------------+ +| *Default* | false | ++-----------+-----------------------------------------------+ +| *Setter* | set_use_continuous_collision_detection(value) | ++-----------+-----------------------------------------------+ +| *Getter* | is_using_continuous_collision_detection() | ++-----------+-----------------------------------------------+ If ``true``, continuous collision detection is used. @@ -333,11 +359,13 @@ Continuous collision detection tries to predict where a moving body will collide - :ref:`bool` **custom_integrator** -+----------+----------------------------------+ -| *Setter* | set_use_custom_integrator(value) | -+----------+----------------------------------+ -| *Getter* | is_using_custom_integrator() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_use_custom_integrator(value) | ++-----------+----------------------------------+ +| *Getter* | is_using_custom_integrator() | ++-----------+----------------------------------+ If ``true``, internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. @@ -353,15 +381,19 @@ If ``true``, internal force integration will be disabled (like gravity or air fr The body's friction, from 0 (frictionless) to 1 (max friction). +Deprecated, use :ref:`PhysicsMaterial.friction` instead via :ref:`physics_material_override`. + .. _class_RigidBody_property_gravity_scale: - :ref:`float` **gravity_scale** -+----------+--------------------------+ -| *Setter* | set_gravity_scale(value) | -+----------+--------------------------+ -| *Getter* | get_gravity_scale() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_gravity_scale(value) | ++-----------+--------------------------+ +| *Getter* | get_gravity_scale() | ++-----------+--------------------------+ This is multiplied by the global 3D gravity setting found in **Project > Project Settings > Physics > 3d** to produce RigidBody's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. @@ -369,23 +401,27 @@ This is multiplied by the global 3D gravity setting found in **Project > Project - :ref:`float` **linear_damp** -+----------+------------------------+ -| *Setter* | set_linear_damp(value) | -+----------+------------------------+ -| *Getter* | get_linear_damp() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | -1.0 | ++-----------+------------------------+ +| *Setter* | set_linear_damp(value) | ++-----------+------------------------+ +| *Getter* | get_linear_damp() | ++-----------+------------------------+ -The body's linear damp. Default value: -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. +The body's linear damp. Cannot be less than -1.0. If this value is different from -1.0, any linear damp derived from the world or areas will be overridden. .. _class_RigidBody_property_linear_velocity: - :ref:`Vector3` **linear_velocity** -+----------+----------------------------+ -| *Setter* | set_linear_velocity(value) | -+----------+----------------------------+ -| *Getter* | get_linear_velocity() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++-----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++-----------+----------------------------+ The body's linear velocity. Can be used sporadically, but **don't set this every frame**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. @@ -393,11 +429,13 @@ The body's linear velocity. Can be used sporadically, but **don't set this every - :ref:`float` **mass** -+----------+-----------------+ -| *Setter* | set_mass(value) | -+----------+-----------------+ -| *Getter* | get_mass() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 1.0 | ++-----------+-----------------+ +| *Setter* | set_mass(value) | ++-----------+-----------------+ +| *Getter* | get_mass() | ++-----------+-----------------+ The body's mass. @@ -405,33 +443,39 @@ The body's mass. - :ref:`Mode` **mode** -+----------+-----------------+ -| *Setter* | set_mode(value) | -+----------+-----------------+ -| *Getter* | get_mode() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_mode(value) | ++-----------+-----------------+ +| *Getter* | get_mode() | ++-----------+-----------------+ -The body mode. See :ref:`Mode` for possible values. Default value: ``MODE_RIGID``. +The body mode. See :ref:`Mode` for possible values. .. _class_RigidBody_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** -+----------+--------------------------------------+ -| *Setter* | set_physics_material_override(value) | -+----------+--------------------------------------+ -| *Getter* | get_physics_material_override() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | null | ++-----------+--------------------------------------+ +| *Setter* | set_physics_material_override(value) | ++-----------+--------------------------------------+ +| *Getter* | get_physics_material_override() | ++-----------+--------------------------------------+ .. _class_RigidBody_property_sleeping: - :ref:`bool` **sleeping** -+----------+---------------------+ -| *Setter* | set_sleeping(value) | -+----------+---------------------+ -| *Getter* | is_sleeping() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_sleeping(value) | ++-----------+---------------------+ +| *Getter* | is_sleeping() | ++-----------+---------------------+ If ``true``, the body is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. @@ -439,11 +483,13 @@ If ``true``, the body is sleeping and will not calculate forces until woken up b - :ref:`float` **weight** -+----------+-------------------+ -| *Setter* | set_weight(value) | -+----------+-------------------+ -| *Getter* | get_weight() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 9.8 | ++-----------+-------------------+ +| *Setter* | set_weight(value) | ++-----------+-------------------+ +| *Getter* | get_weight() | ++-----------+-------------------+ The body's weight based on its mass and the global 3D gravity. Global values are set in **Project > Project Settings > Physics > 3d**. diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 0d7569a9f..45a094dcf 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -19,47 +19,47 @@ A body that is controlled by the 2D physics engine. Properties ---------- -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`applied_force` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`applied_torque` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_sleep` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`contact_monitor` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`contacts_reported` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`CCDMode` | :ref:`continuous_cd` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`custom_integrator` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_scale` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inertia` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`linear_velocity` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mass` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sleeping` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`weight` | -+-----------------------------------------------+----------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`angular_damp` | -1.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`angular_velocity` | 0.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`applied_force` | Vector2( 0, 0 ) | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`applied_torque` | 0.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`bounce` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`can_sleep` | true | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`contact_monitor` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`contacts_reported` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`CCDMode` | :ref:`continuous_cd` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`custom_integrator` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`friction` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`gravity_scale` | 1.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`inertia` | | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`linear_damp` | -1.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`linear_velocity` | Vector2( 0, 0 ) | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`mass` | 1.0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`Mode` | :ref:`mode` | 0 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | null | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`sleeping` | false | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`weight` | 9.8 | ++-----------------------------------------------+----------------------------------------------------------------------------------------+-----------------+ Methods ------- @@ -178,23 +178,27 @@ Property Descriptions - :ref:`float` **angular_damp** -+----------+-------------------------+ -| *Setter* | set_angular_damp(value) | -+----------+-------------------------+ -| *Getter* | get_angular_damp() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | -1.0 | ++-----------+-------------------------+ +| *Setter* | set_angular_damp(value) | ++-----------+-------------------------+ +| *Getter* | get_angular_damp() | ++-----------+-------------------------+ -Damps the body's :ref:`angular_velocity`. If ``-1``, the body will use the **Default Angular Damp** defined in **Project > Project Settings > Physics > 2d**. Default value: ``-1``. +Damps the body's :ref:`angular_velocity`. If ``-1``, the body will use the **Default Angular Damp** defined in **Project > Project Settings > Physics > 2d**. .. _class_RigidBody2D_property_angular_velocity: - :ref:`float` **angular_velocity** -+----------+-----------------------------+ -| *Setter* | set_angular_velocity(value) | -+----------+-----------------------------+ -| *Getter* | get_angular_velocity() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++-----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++-----------+-----------------------------+ The body's rotational velocity. @@ -202,11 +206,13 @@ The body's rotational velocity. - :ref:`Vector2` **applied_force** -+----------+--------------------------+ -| *Setter* | set_applied_force(value) | -+----------+--------------------------+ -| *Getter* | get_applied_force() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+--------------------------+ +| *Setter* | set_applied_force(value) | ++-----------+--------------------------+ +| *Getter* | get_applied_force() | ++-----------+--------------------------+ The body's total applied force. @@ -214,11 +220,13 @@ The body's total applied force. - :ref:`float` **applied_torque** -+----------+---------------------------+ -| *Setter* | set_applied_torque(value) | -+----------+---------------------------+ -| *Getter* | get_applied_torque() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0.0 | ++-----------+---------------------------+ +| *Setter* | set_applied_torque(value) | ++-----------+---------------------------+ +| *Getter* | get_applied_torque() | ++-----------+---------------------------+ The body's total applied torque. @@ -232,55 +240,65 @@ The body's total applied torque. | *Getter* | get_bounce() | +----------+-------------------+ -The body's bounciness. Default value: ``0``. +The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). + +Deprecated, use :ref:`PhysicsMaterial.bounce` instead via :ref:`physics_material_override`. .. _class_RigidBody2D_property_can_sleep: - :ref:`bool` **can_sleep** -+----------+----------------------+ -| *Setter* | set_can_sleep(value) | -+----------+----------------------+ -| *Getter* | is_able_to_sleep() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_can_sleep(value) | ++-----------+----------------------+ +| *Getter* | is_able_to_sleep() | ++-----------+----------------------+ -If ``true``, the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. Default value: ``true``. +If ``true``, the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. .. _class_RigidBody2D_property_contact_monitor: - :ref:`bool` **contact_monitor** -+----------+------------------------------+ -| *Setter* | set_contact_monitor(value) | -+----------+------------------------------+ -| *Getter* | is_contact_monitor_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_contact_monitor(value) | ++-----------+------------------------------+ +| *Getter* | is_contact_monitor_enabled() | ++-----------+------------------------------+ -If ``true``, the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. +If ``true``, the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. .. _class_RigidBody2D_property_contacts_reported: - :ref:`int` **contacts_reported** -+----------+----------------------------------+ -| *Setter* | set_max_contacts_reported(value) | -+----------+----------------------------------+ -| *Getter* | get_max_contacts_reported() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 0 | ++-----------+----------------------------------+ +| *Setter* | set_max_contacts_reported(value) | ++-----------+----------------------------------+ +| *Getter* | get_max_contacts_reported() | ++-----------+----------------------------------+ -The maximum number of contacts to report. Default value: ``0``. +The maximum number of contacts to report. .. _class_RigidBody2D_property_continuous_cd: - :ref:`CCDMode` **continuous_cd** -+----------+------------------------------------------------+ -| *Setter* | set_continuous_collision_detection_mode(value) | -+----------+------------------------------------------------+ -| *Getter* | get_continuous_collision_detection_mode() | -+----------+------------------------------------------------+ ++-----------+------------------------------------------------+ +| *Default* | 0 | ++-----------+------------------------------------------------+ +| *Setter* | set_continuous_collision_detection_mode(value) | ++-----------+------------------------------------------------+ +| *Getter* | get_continuous_collision_detection_mode() | ++-----------+------------------------------------------------+ -Continuous collision detection mode. Default value: :ref:`CCD_MODE_DISABLED`. +Continuous collision detection mode. Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See :ref:`CCDMode` for details. @@ -288,11 +306,13 @@ Continuous collision detection tries to predict where a moving body will collide - :ref:`bool` **custom_integrator** -+----------+----------------------------------+ -| *Setter* | set_use_custom_integrator(value) | -+----------+----------------------------------+ -| *Getter* | is_using_custom_integrator() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_use_custom_integrator(value) | ++-----------+----------------------------------+ +| *Getter* | is_using_custom_integrator() | ++-----------+----------------------------------+ If ``true``, internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. @@ -306,19 +326,23 @@ If ``true``, internal force integration is disabled for this body. Aside from co | *Getter* | get_friction() | +----------+---------------------+ -The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. +The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). + +Deprecated, use :ref:`PhysicsMaterial.friction` instead via :ref:`physics_material_override`. .. _class_RigidBody2D_property_gravity_scale: - :ref:`float` **gravity_scale** -+----------+--------------------------+ -| *Setter* | set_gravity_scale(value) | -+----------+--------------------------+ -| *Getter* | get_gravity_scale() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_gravity_scale(value) | ++-----------+--------------------------+ +| *Getter* | get_gravity_scale() | ++-----------+--------------------------+ -Multiplies the gravity applied to the body. The body's gravity is calculated from the **Default Gravity** value in **Project > Project Settings > Physics > 2d** and/or any additional gravity vector applied by :ref:`Area2D`\ s. Default value: ``1``. +Multiplies the gravity applied to the body. The body's gravity is calculated from the **Default Gravity** value in **Project > Project Settings > Physics > 2d** and/or any additional gravity vector applied by :ref:`Area2D`\ s. .. _class_RigidBody2D_property_inertia: @@ -336,23 +360,27 @@ The body's moment of inertia. This is like mass, but for rotation: it determines - :ref:`float` **linear_damp** -+----------+------------------------+ -| *Setter* | set_linear_damp(value) | -+----------+------------------------+ -| *Getter* | get_linear_damp() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | -1.0 | ++-----------+------------------------+ +| *Setter* | set_linear_damp(value) | ++-----------+------------------------+ +| *Getter* | get_linear_damp() | ++-----------+------------------------+ -Damps the body's :ref:`linear_velocity`. If ``-1``, the body will use the **Default Linear Damp** in **Project > Project Settings > Physics > 2d**. Default value: ``-1``. +Damps the body's :ref:`linear_velocity`. If ``-1``, the body will use the **Default Linear Damp** in **Project > Project Settings > Physics > 2d**. .. _class_RigidBody2D_property_linear_velocity: - :ref:`Vector2` **linear_velocity** -+----------+----------------------------+ -| *Setter* | set_linear_velocity(value) | -+----------+----------------------------+ -| *Getter* | get_linear_velocity() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++-----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++-----------+----------------------------+ The body's linear velocity. @@ -360,45 +388,53 @@ The body's linear velocity. - :ref:`float` **mass** -+----------+-----------------+ -| *Setter* | set_mass(value) | -+----------+-----------------+ -| *Getter* | get_mass() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 1.0 | ++-----------+-----------------+ +| *Setter* | set_mass(value) | ++-----------+-----------------+ +| *Getter* | get_mass() | ++-----------+-----------------+ -The body's mass. Default value: ``1``. +The body's mass. .. _class_RigidBody2D_property_mode: - :ref:`Mode` **mode** -+----------+-----------------+ -| *Setter* | set_mode(value) | -+----------+-----------------+ -| *Getter* | get_mode() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_mode(value) | ++-----------+-----------------+ +| *Getter* | get_mode() | ++-----------+-----------------+ -The body's mode. See :ref:`Mode` for possible values. Default value: :ref:`MODE_RIGID`. +The body's mode. See :ref:`Mode` for possible values. .. _class_RigidBody2D_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** -+----------+--------------------------------------+ -| *Setter* | set_physics_material_override(value) | -+----------+--------------------------------------+ -| *Getter* | get_physics_material_override() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | null | ++-----------+--------------------------------------+ +| *Setter* | set_physics_material_override(value) | ++-----------+--------------------------------------+ +| *Getter* | get_physics_material_override() | ++-----------+--------------------------------------+ .. _class_RigidBody2D_property_sleeping: - :ref:`bool` **sleeping** -+----------+---------------------+ -| *Setter* | set_sleeping(value) | -+----------+---------------------+ -| *Getter* | is_sleeping() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_sleeping(value) | ++-----------+---------------------+ +| *Getter* | is_sleeping() | ++-----------+---------------------+ If ``true``, the body is sleeping and will not calculate forces until woken up by a collision or by using :ref:`apply_impulse` or :ref:`add_force`. @@ -406,11 +442,13 @@ If ``true``, the body is sleeping and will not calculate forces until woken up b - :ref:`float` **weight** -+----------+-------------------+ -| *Setter* | set_weight(value) | -+----------+-------------------+ -| *Getter* | get_weight() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 9.8 | ++-----------+-------------------+ +| *Setter* | set_weight(value) | ++-----------+-------------------+ +| *Getter* | get_weight() | ++-----------+-------------------+ The body's weight based on its mass and the **Default Gravity** value in **Project > Project Settings > Physics > 2d**. diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index b0673a2aa..c5939e043 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -19,29 +19,29 @@ Manages the game loop via a hierarchy of nodes. Properties ---------- -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`current_scene` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug_collisions_hint` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug_navigation_hint` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`edited_scene_root` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`MultiplayerAPI` | :ref:`multiplayer` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`multiplayer_poll` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`paused` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`refuse_new_network_connections` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`root` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_font_oversampling` | -+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`Node` | :ref:`current_scene` | | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`debug_collisions_hint` | false | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`debug_navigation_hint` | false | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`Node` | :ref:`edited_scene_root` | | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`MultiplayerAPI` | :ref:`multiplayer` | | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`multiplayer_poll` | true | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`paused` | false | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`refuse_new_network_connections` | false | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`Viewport` | :ref:`root` | | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`use_font_oversampling` | false | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------+ Methods ------- @@ -285,11 +285,13 @@ The current scene. - :ref:`bool` **debug_collisions_hint** -+----------+----------------------------------+ -| *Setter* | set_debug_collisions_hint(value) | -+----------+----------------------------------+ -| *Getter* | is_debugging_collisions_hint() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_debug_collisions_hint(value) | ++-----------+----------------------------------+ +| *Getter* | is_debugging_collisions_hint() | ++-----------+----------------------------------+ If ``true``, collision shapes will be visible when running the game from the editor for debugging purposes. @@ -297,11 +299,13 @@ If ``true``, collision shapes will be visible when running the game from the edi - :ref:`bool` **debug_navigation_hint** -+----------+----------------------------------+ -| *Setter* | set_debug_navigation_hint(value) | -+----------+----------------------------------+ -| *Getter* | is_debugging_navigation_hint() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_debug_navigation_hint(value) | ++-----------+----------------------------------+ +| *Getter* | is_debugging_navigation_hint() | ++-----------+----------------------------------+ If ``true``, navigation polygons will be visible when running the game from the editor for debugging purposes. @@ -333,11 +337,13 @@ The default :ref:`MultiplayerAPI` instance for this ``Scen - :ref:`bool` **multiplayer_poll** -+----------+-------------------------------------+ -| *Setter* | set_multiplayer_poll_enabled(value) | -+----------+-------------------------------------+ -| *Getter* | is_multiplayer_poll_enabled() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | true | ++-----------+-------------------------------------+ +| *Setter* | set_multiplayer_poll_enabled(value) | ++-----------+-------------------------------------+ +| *Getter* | is_multiplayer_poll_enabled() | ++-----------+-------------------------------------+ If ``true`` (default value), enables automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`idle_frame`. @@ -359,11 +365,13 @@ The peer object to handle the RPC system (effectively enabling networking when s - :ref:`bool` **paused** -+----------+------------------+ -| *Setter* | set_pause(value) | -+----------+------------------+ -| *Getter* | is_paused() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | false | ++-----------+------------------+ +| *Setter* | set_pause(value) | ++-----------+------------------+ +| *Getter* | is_paused() | ++-----------+------------------+ If ``true``, the ``SceneTree`` is paused. Doing so will have the following behavior: @@ -375,11 +383,13 @@ If ``true``, the ``SceneTree`` is paused. Doing so will have the following behav - :ref:`bool` **refuse_new_network_connections** -+----------+-------------------------------------------+ -| *Setter* | set_refuse_new_network_connections(value) | -+----------+-------------------------------------------+ -| *Getter* | is_refusing_new_network_connections() | -+----------+-------------------------------------------+ ++-----------+-------------------------------------------+ +| *Default* | false | ++-----------+-------------------------------------------+ +| *Setter* | set_refuse_new_network_connections(value) | ++-----------+-------------------------------------------+ +| *Getter* | is_refusing_new_network_connections() | ++-----------+-------------------------------------------+ If ``true``, the ``SceneTree``'s :ref:`network_peer` refuses new incoming connections. @@ -397,11 +407,13 @@ The ``SceneTree``'s root :ref:`Viewport`. - :ref:`bool` **use_font_oversampling** -+----------+----------------------------------+ -| *Setter* | set_use_font_oversampling(value) | -+----------+----------------------------------+ -| *Getter* | is_using_font_oversampling() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | false | ++-----------+----------------------------------+ +| *Setter* | set_use_font_oversampling(value) | ++-----------+----------------------------------+ +| *Getter* | is_using_font_oversampling() | ++-----------+----------------------------------+ If ``true``, font oversampling is used. @@ -547,7 +559,7 @@ Returns an :ref:`Error` code as described in :ref:`chan - void **set_auto_accept_quit** **(** :ref:`bool` enabled **)** -If ``true``, the application automatically accepts quitting. Defaults to ``true``. +If ``true``, the application automatically accepts quitting. Enabled by default. .. _class_SceneTree_method_set_group: @@ -571,7 +583,7 @@ Marks the most recent :ref:`InputEvent` as handled. - void **set_quit_on_go_back** **(** :ref:`bool` enabled **)** -If ``true``, the application quits automatically on going back (e.g. on Android). Defaults to ``true``. +If ``true``, the application quits automatically on going back (e.g. on Android). Enabled by default. .. _class_SceneTree_method_set_screen_stretch: diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 53fb56fd2..eb72802b1 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -21,9 +21,9 @@ Base class for scroll bars. Properties ---------- -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`custom_step` | -+---------------------------+----------------------------------------------------------+ ++---------------------------+----------------------------------------------------------+------+ +| :ref:`float` | :ref:`custom_step` | -1.0 | ++---------------------------+----------------------------------------------------------+------+ Signals ------- @@ -46,9 +46,11 @@ Property Descriptions - :ref:`float` **custom_step** -+----------+------------------------+ -| *Setter* | set_custom_step(value) | -+----------+------------------------+ -| *Getter* | get_custom_step() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | -1.0 | ++-----------+------------------------+ +| *Setter* | set_custom_step(value) | ++-----------+------------------------+ +| *Getter* | get_custom_step() | ++-----------+------------------------+ diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index db8741b61..46878aa99 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -21,17 +21,17 @@ A helper node for displaying scrollable elements such as lists. Properties ---------- -+-------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scroll_deadzone` | -+-------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scroll_horizontal` | -+-------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_horizontal_enabled` | -+-------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scroll_vertical` | -+-------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_vertical_enabled` | -+-------------------------+--------------------------------------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`scroll_deadzone` | 0 | ++-------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`scroll_horizontal` | 0 | ++-------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`scroll_horizontal_enabled` | true | ++-------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`int` | :ref:`scroll_vertical` | 0 | ++-------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`scroll_vertical_enabled` | true | ++-------------------------+--------------------------------------------------------------------------------------------+------+ Methods ------- @@ -76,21 +76,25 @@ Property Descriptions - :ref:`int` **scroll_deadzone** -+----------+---------------------+ -| *Setter* | set_deadzone(value) | -+----------+---------------------+ -| *Getter* | get_deadzone() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_deadzone(value) | ++-----------+---------------------+ +| *Getter* | get_deadzone() | ++-----------+---------------------+ .. _class_ScrollContainer_property_scroll_horizontal: - :ref:`int` **scroll_horizontal** -+----------+---------------------+ -| *Setter* | set_h_scroll(value) | -+----------+---------------------+ -| *Getter* | get_h_scroll() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_h_scroll(value) | ++-----------+---------------------+ +| *Getter* | get_h_scroll() | ++-----------+---------------------+ The current horizontal scroll value. @@ -98,11 +102,13 @@ The current horizontal scroll value. - :ref:`bool` **scroll_horizontal_enabled** -+----------+----------------------------+ -| *Setter* | set_enable_h_scroll(value) | -+----------+----------------------------+ -| *Getter* | is_h_scroll_enabled() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | true | ++-----------+----------------------------+ +| *Setter* | set_enable_h_scroll(value) | ++-----------+----------------------------+ +| *Getter* | is_h_scroll_enabled() | ++-----------+----------------------------+ If ``true``, enables horizontal scrolling. @@ -110,11 +116,13 @@ If ``true``, enables horizontal scrolling. - :ref:`int` **scroll_vertical** -+----------+---------------------+ -| *Setter* | set_v_scroll(value) | -+----------+---------------------+ -| *Getter* | get_v_scroll() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_v_scroll(value) | ++-----------+---------------------+ +| *Getter* | get_v_scroll() | ++-----------+---------------------+ The current vertical scroll value. @@ -122,11 +130,13 @@ The current vertical scroll value. - :ref:`bool` **scroll_vertical_enabled** -+----------+----------------------------+ -| *Setter* | set_enable_v_scroll(value) | -+----------+----------------------------+ -| *Getter* | is_v_scroll_enabled() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | true | ++-----------+----------------------------+ +| *Setter* | set_enable_v_scroll(value) | ++-----------+----------------------------+ +| *Getter* | is_v_scroll_enabled() | ++-----------+----------------------------+ If ``true``, enables vertical scrolling. diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index d87cc8e58..9b1a046c6 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -19,11 +19,11 @@ Segment shape for 2D collisions. Properties ---------- -+-------------------------------+-------------------------------------------+ -| :ref:`Vector2` | :ref:`a` | -+-------------------------------+-------------------------------------------+ -| :ref:`Vector2` | :ref:`b` | -+-------------------------------+-------------------------------------------+ ++-------------------------------+-------------------------------------------+------------------+ +| :ref:`Vector2` | :ref:`a` | Vector2( 0, 0 ) | ++-------------------------------+-------------------------------------------+------------------+ +| :ref:`Vector2` | :ref:`b` | Vector2( 0, 10 ) | ++-------------------------------+-------------------------------------------+------------------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`Vector2` **a** -+----------+--------------+ -| *Setter* | set_a(value) | -+----------+--------------+ -| *Getter* | get_a() | -+----------+--------------+ ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ +| *Setter* | set_a(value) | ++-----------+-----------------+ +| *Getter* | get_a() | ++-----------+-----------------+ The segment's first point position. @@ -49,11 +51,13 @@ The segment's first point position. - :ref:`Vector2` **b** -+----------+--------------+ -| *Setter* | set_b(value) | -+----------+--------------+ -| *Getter* | get_b() | -+----------+--------------+ ++-----------+------------------+ +| *Default* | Vector2( 0, 10 ) | ++-----------+------------------+ +| *Setter* | set_b(value) | ++-----------+------------------+ +| *Getter* | get_b() | ++-----------+------------------+ The segment's second point position. diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 484a6a0f4..8b1ddb1c6 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -21,9 +21,9 @@ A custom shader program. Properties ---------- -+-----------------------------+-----------------------------------------+ -| :ref:`String` | :ref:`code` | -+-----------------------------+-----------------------------------------+ ++-----------------------------+-----------------------------------------+----+ +| :ref:`String` | :ref:`code` | "" | ++-----------------------------+-----------------------------------------+----+ Methods ------- @@ -74,11 +74,13 @@ Property Descriptions - :ref:`String` **code** -+----------+-----------------+ -| *Setter* | set_code(value) | -+----------+-----------------+ -| *Getter* | get_code() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | set_code(value) | ++-----------+-----------------+ +| *Getter* | get_code() | ++-----------+-----------------+ Method Descriptions ------------------- diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 62ca9a030..734773ea1 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -19,9 +19,9 @@ A material that uses a custom :ref:`Shader` program. Properties ---------- -+-----------------------------+-----------------------------------------------------+ -| :ref:`Shader` | :ref:`shader` | -+-----------------------------+-----------------------------------------------------+ ++-----------------------------+-----------------------------------------------------+------+ +| :ref:`Shader` | :ref:`shader` | null | ++-----------------------------+-----------------------------------------------------+------+ Methods ------- @@ -53,11 +53,13 @@ Property Descriptions - :ref:`Shader` **shader** -+----------+-------------------+ -| *Setter* | set_shader(value) | -+----------+-------------------+ -| *Getter* | get_shader() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | null | ++-----------+-------------------+ +| *Setter* | set_shader(value) | ++-----------+-------------------+ +| *Getter* | get_shader() | ++-----------+-------------------+ The :ref:`Shader` program used to render this material. diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 9802b77a4..a1eee0982 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -21,9 +21,9 @@ Base class for all 3D shape resources. Properties ---------- -+---------------------------+--------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+---------------------------+--------------------------------------------+ ++---------------------------+--------------------------------------------+------+ +| :ref:`float` | :ref:`margin` | 0.04 | ++---------------------------+--------------------------------------------+------+ Description ----------- @@ -42,9 +42,11 @@ Property Descriptions - :ref:`float` **margin** -+----------+-------------------+ -| *Setter* | set_margin(value) | -+----------+-------------------+ -| *Getter* | get_margin() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.04 | ++-----------+-------------------+ +| *Setter* | set_margin(value) | ++-----------+-------------------+ +| *Getter* | get_margin() | ++-----------+-------------------+ diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 89b1b4d32..b6fd8f0ce 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -21,9 +21,9 @@ Base class for all 2D shapes. Properties ---------- -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`custom_solver_bias` | -+---------------------------+----------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`custom_solver_bias` | 0.0 | ++---------------------------+----------------------------------------------------------------------+-----+ Methods ------- @@ -55,11 +55,13 @@ Property Descriptions - :ref:`float` **custom_solver_bias** -+----------+-------------------------------+ -| *Setter* | set_custom_solver_bias(value) | -+----------+-------------------------------+ -| *Getter* | get_custom_solver_bias() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------+ +| *Setter* | set_custom_solver_bias(value) | ++-----------+-------------------------------+ +| *Getter* | get_custom_solver_bias() | ++-----------+-------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 2e3e6ab18..af55e97fe 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -19,9 +19,9 @@ A shortcut for binding input. Properties ---------- -+-------------------------------------+---------------------------------------------------+ -| :ref:`InputEvent` | :ref:`shortcut` | -+-------------------------------------+---------------------------------------------------+ ++-------------------------------------+---------------------------------------------------+------+ +| :ref:`InputEvent` | :ref:`shortcut` | null | ++-------------------------------------+---------------------------------------------------+------+ Methods ------- @@ -48,11 +48,13 @@ Property Descriptions - :ref:`InputEvent` **shortcut** -+----------+---------------------+ -| *Setter* | set_shortcut(value) | -+----------+---------------------+ -| *Getter* | get_shortcut() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_shortcut(value) | ++-----------+---------------------+ +| *Getter* | get_shortcut() | ++-----------+---------------------+ The shortcut's :ref:`InputEvent`. diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index 0af243014..db4a42ab9 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -19,9 +19,9 @@ Skeleton for characters and animated objects. Properties ---------- -+-------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bones_in_world_transform` | -+-------------------------+-----------------------------------------------------------------------------------+ ++-------------------------+-----------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`bones_in_world_transform` | false | ++-------------------------+-----------------------------------------------------------------------------------+-------+ Methods ------- @@ -107,11 +107,13 @@ Property Descriptions - :ref:`bool` **bones_in_world_transform** -+----------+-----------------------------------------+ -| *Setter* | set_use_bones_in_world_transform(value) | -+----------+-----------------------------------------+ -| *Getter* | is_using_bones_in_world_transform() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | false | ++-----------+-----------------------------------------+ +| *Setter* | set_use_bones_in_world_transform(value) | ++-----------+-----------------------------------------+ +| *Getter* | is_using_bones_in_world_transform() | ++-----------+-----------------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index 86a8b19cb..bb9d89467 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -19,27 +19,27 @@ Brief Description Properties ---------- -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolation` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`magnet` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_iterations` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`float` | :ref:`min_distance` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`override_tip_basis` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`String` | :ref:`root_bone` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`target` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`target_node` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tip_bone` | -+-----------------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_magnet` | -+-----------------------------------+-------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`interpolation` | 1.0 | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Vector3` | :ref:`magnet` | Vector3( 0, 0, 0 ) | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`int` | :ref:`max_iterations` | 10 | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`min_distance` | 0.01 | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`bool` | :ref:`override_tip_basis` | true | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`String` | :ref:`root_bone` | "" | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`target` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`NodePath` | :ref:`target_node` | NodePath("") | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`String` | :ref:`tip_bone` | "" | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`bool` | :ref:`use_magnet` | false | ++-----------------------------------+-------------------------------------------------------------------------+-------------------------------------------------+ Methods ------- @@ -61,101 +61,121 @@ Property Descriptions - :ref:`float` **interpolation** -+----------+--------------------------+ -| *Setter* | set_interpolation(value) | -+----------+--------------------------+ -| *Getter* | get_interpolation() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 1.0 | ++-----------+--------------------------+ +| *Setter* | set_interpolation(value) | ++-----------+--------------------------+ +| *Getter* | get_interpolation() | ++-----------+--------------------------+ .. _class_SkeletonIK_property_magnet: - :ref:`Vector3` **magnet** -+----------+----------------------------+ -| *Setter* | set_magnet_position(value) | -+----------+----------------------------+ -| *Getter* | get_magnet_position() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+----------------------------+ +| *Setter* | set_magnet_position(value) | ++-----------+----------------------------+ +| *Getter* | get_magnet_position() | ++-----------+----------------------------+ .. _class_SkeletonIK_property_max_iterations: - :ref:`int` **max_iterations** -+----------+---------------------------+ -| *Setter* | set_max_iterations(value) | -+----------+---------------------------+ -| *Getter* | get_max_iterations() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 10 | ++-----------+---------------------------+ +| *Setter* | set_max_iterations(value) | ++-----------+---------------------------+ +| *Getter* | get_max_iterations() | ++-----------+---------------------------+ .. _class_SkeletonIK_property_min_distance: - :ref:`float` **min_distance** -+----------+-------------------------+ -| *Setter* | set_min_distance(value) | -+----------+-------------------------+ -| *Getter* | get_min_distance() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0.01 | ++-----------+-------------------------+ +| *Setter* | set_min_distance(value) | ++-----------+-------------------------+ +| *Getter* | get_min_distance() | ++-----------+-------------------------+ .. _class_SkeletonIK_property_override_tip_basis: - :ref:`bool` **override_tip_basis** -+----------+-------------------------------+ -| *Setter* | set_override_tip_basis(value) | -+----------+-------------------------------+ -| *Getter* | is_override_tip_basis() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | true | ++-----------+-------------------------------+ +| *Setter* | set_override_tip_basis(value) | ++-----------+-------------------------------+ +| *Getter* | is_override_tip_basis() | ++-----------+-------------------------------+ .. _class_SkeletonIK_property_root_bone: - :ref:`String` **root_bone** -+----------+----------------------+ -| *Setter* | set_root_bone(value) | -+----------+----------------------+ -| *Getter* | get_root_bone() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "" | ++-----------+----------------------+ +| *Setter* | set_root_bone(value) | ++-----------+----------------------+ +| *Getter* | get_root_bone() | ++-----------+----------------------+ .. _class_SkeletonIK_property_target: - :ref:`Transform` **target** -+----------+-----------------------------+ -| *Setter* | set_target_transform(value) | -+----------+-----------------------------+ -| *Getter* | get_target_transform() | -+----------+-----------------------------+ ++-----------+-------------------------------------------------+ +| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------+-------------------------------------------------+ +| *Setter* | set_target_transform(value) | ++-----------+-------------------------------------------------+ +| *Getter* | get_target_transform() | ++-----------+-------------------------------------------------+ .. _class_SkeletonIK_property_target_node: - :ref:`NodePath` **target_node** -+----------+------------------------+ -| *Setter* | set_target_node(value) | -+----------+------------------------+ -| *Getter* | get_target_node() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | NodePath("") | ++-----------+------------------------+ +| *Setter* | set_target_node(value) | ++-----------+------------------------+ +| *Getter* | get_target_node() | ++-----------+------------------------+ .. _class_SkeletonIK_property_tip_bone: - :ref:`String` **tip_bone** -+----------+---------------------+ -| *Setter* | set_tip_bone(value) | -+----------+---------------------+ -| *Getter* | get_tip_bone() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | "" | ++-----------+---------------------+ +| *Setter* | set_tip_bone(value) | ++-----------+---------------------+ +| *Getter* | get_tip_bone() | ++-----------+---------------------+ .. _class_SkeletonIK_property_use_magnet: - :ref:`bool` **use_magnet** -+----------+-----------------------+ -| *Setter* | set_use_magnet(value) | -+----------+-----------------------+ -| *Getter* | is_using_magnet() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | false | ++-----------+-----------------------+ +| *Setter* | set_use_magnet(value) | ++-----------+-----------------------+ +| *Getter* | is_using_magnet() | ++-----------+-----------------------+ Method Descriptions ------------------- diff --git a/classes/class_sky.rst b/classes/class_sky.rst index fb684f997..9d9dbcf8f 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -21,9 +21,9 @@ The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky Properties ---------- -+--------------------------------------------+--------------------------------------------------------+ -| :ref:`RadianceSize` | :ref:`radiance_size` | -+--------------------------------------------+--------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------+---+ +| :ref:`RadianceSize` | :ref:`radiance_size` | 2 | ++--------------------------------------------+--------------------------------------------------------+---+ Enumerations ------------ @@ -76,13 +76,15 @@ Property Descriptions - :ref:`RadianceSize` **radiance_size** -+----------+--------------------------+ -| *Setter* | set_radiance_size(value) | -+----------+--------------------------+ -| *Getter* | get_radiance_size() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 2 | ++-----------+--------------------------+ +| *Setter* | set_radiance_size(value) | ++-----------+--------------------------+ +| *Getter* | get_radiance_size() | ++-----------+--------------------------+ The ``Sky``'s radiance map size. The higher the radiance map size, the more detailed the lighting from the ``Sky`` will be. -See :ref:`RadianceSize` constants for values. Default size is :ref:`RADIANCE_SIZE_512`. +See :ref:`RadianceSize` constants for values. diff --git a/classes/class_slider.rst b/classes/class_slider.rst index f8324d04c..f5f3ae0c1 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -21,17 +21,17 @@ Base class for GUI sliders. Properties ---------- -+------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`editable` | -+------------------------------------------+-----------------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`focus_mode` | -+------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`scrollable` | -+------------------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`tick_count` | -+------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`ticks_on_borders` | -+------------------------------------------+-----------------------------------------------------------------+ ++------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`editable` | true | ++------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`FocusMode` | :ref:`focus_mode` | 2 | ++------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`scrollable` | true | ++------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`tick_count` | 0 | ++------------------------------------------+-----------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`ticks_on_borders` | false | ++------------------------------------------+-----------------------------------------------------------------+-------+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`bool` **editable** -+----------+---------------------+ -| *Setter* | set_editable(value) | -+----------+---------------------+ -| *Getter* | is_editable() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_editable(value) | ++-----------+---------------------+ +| *Getter* | is_editable() | ++-----------+---------------------+ If ``true``, the slider can be interacted with. If ``false``, the value can be changed only by code. @@ -57,21 +59,25 @@ If ``true``, the slider can be interacted with. If ``false``, the value can be c - :ref:`FocusMode` **focus_mode** -+----------+-----------------------+ -| *Setter* | set_focus_mode(value) | -+----------+-----------------------+ -| *Getter* | get_focus_mode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 2 | ++-----------+-----------------------+ +| *Setter* | set_focus_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_focus_mode() | ++-----------+-----------------------+ .. _class_Slider_property_scrollable: - :ref:`bool` **scrollable** -+----------+-----------------------+ -| *Setter* | set_scrollable(value) | -+----------+-----------------------+ -| *Getter* | is_scrollable() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | true | ++-----------+-----------------------+ +| *Setter* | set_scrollable(value) | ++-----------+-----------------------+ +| *Getter* | is_scrollable() | ++-----------+-----------------------+ If ``true``, the value can be changed using the mouse wheel. @@ -79,11 +85,13 @@ If ``true``, the value can be changed using the mouse wheel. - :ref:`int` **tick_count** -+----------+------------------+ -| *Setter* | set_ticks(value) | -+----------+------------------+ -| *Getter* | get_ticks() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_ticks(value) | ++-----------+------------------+ +| *Getter* | get_ticks() | ++-----------+------------------+ Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers. @@ -91,11 +99,13 @@ Number of ticks displayed on the slider, including border ticks. Ticks are unifo - :ref:`bool` **ticks_on_borders** -+----------+-----------------------------+ -| *Setter* | set_ticks_on_borders(value) | -+----------+-----------------------------+ -| *Getter* | get_ticks_on_borders() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | false | ++-----------+-----------------------------+ +| *Setter* | set_ticks_on_borders(value) | ++-----------+-----------------------------+ +| *Getter* | get_ticks_on_borders() | ++-----------+-----------------------------+ If ``true``, the slider will display ticks for minimum and maximum values. diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 5908bf75b..9b681e891 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -19,51 +19,51 @@ Piston kind of slider between two bodies in 3D. Properties ---------- -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/damping` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/lower_angle` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/restitution` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/softness` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/upper_angle` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motion/damping` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motion/restitution` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motion/softness` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_ortho/damping` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_ortho/restitution` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_ortho/softness` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/damping` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/lower_distance` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/restitution` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/softness` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/upper_distance` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motion/damping` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motion/restitution` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motion/softness` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_ortho/damping` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_ortho/restitution` | -+---------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_ortho/softness` | -+---------------------------+--------------------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_limit/damping` | 0.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_limit/lower_angle` | 0.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_limit/restitution` | 0.7 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_limit/softness` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_limit/upper_angle` | 0.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_motion/damping` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_motion/restitution` | 0.7 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_motion/softness` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_ortho/damping` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_ortho/restitution` | 0.7 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`angular_ortho/softness` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_limit/damping` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_limit/lower_distance` | -1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_limit/restitution` | 0.7 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_limit/softness` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_limit/upper_distance` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_motion/damping` | 0.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_motion/restitution` | 0.7 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_motion/softness` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_ortho/damping` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_ortho/restitution` | 0.7 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`linear_ortho/softness` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------------------+------+ Enumerations ------------ @@ -176,11 +176,13 @@ Property Descriptions - :ref:`float` **angular_limit/damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of damping of the rotation when the limit is surpassed. @@ -190,17 +192,23 @@ A lower damping value allows a rotation initiated by body A to travel to body B - :ref:`float` **angular_limit/lower_angle** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The lower limit of rotation in the slider. .. _class_SliderJoint_property_angular_limit/restitution: - :ref:`float` **angular_limit/restitution** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.7 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of restitution of the rotation when the limit is surpassed. @@ -210,11 +218,13 @@ Does not affect damping. - :ref:`float` **angular_limit/softness** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ A factor applied to the all rotation once the limit is surpassed. @@ -224,17 +234,23 @@ Makes all rotation slower when between 0 and 1. - :ref:`float` **angular_limit/upper_angle** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The upper limit of rotation in the slider. .. _class_SliderJoint_property_angular_motion/damping: - :ref:`float` **angular_motion/damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of damping of the rotation in the limits. @@ -242,11 +258,13 @@ The amount of damping of the rotation in the limits. - :ref:`float` **angular_motion/restitution** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.7 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of restitution of the rotation in the limits. @@ -254,11 +272,13 @@ The amount of restitution of the rotation in the limits. - :ref:`float` **angular_motion/softness** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ A factor applied to the all rotation in the limits. @@ -266,11 +286,13 @@ A factor applied to the all rotation in the limits. - :ref:`float` **angular_ortho/damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of damping of the rotation across axes orthogonal to the slider. @@ -278,11 +300,13 @@ The amount of damping of the rotation across axes orthogonal to the slider. - :ref:`float` **angular_ortho/restitution** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.7 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of restitution of the rotation across axes orthogonal to the slider. @@ -290,11 +314,13 @@ The amount of restitution of the rotation across axes orthogonal to the slider. - :ref:`float` **angular_ortho/softness** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ A factor applied to the all rotation across axes orthogonal to the slider. @@ -302,11 +328,13 @@ A factor applied to the all rotation across axes orthogonal to the slider. - :ref:`float` **linear_limit/damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. @@ -314,11 +342,13 @@ The amount of damping that happens once the limit defined by :ref:`linear_limit/ - :ref:`float` **linear_limit/lower_distance** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | -1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The minimum difference between the pivot points on their X axis before damping happens. @@ -326,11 +356,13 @@ The minimum difference between the pivot points on their X axis before damping h - :ref:`float` **linear_limit/restitution** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.7 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. @@ -338,11 +370,13 @@ The amount of restitution once the limits are surpassed. The lower, the more vel - :ref:`float` **linear_limit/softness** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. @@ -350,11 +384,13 @@ A factor applied to the movement across the slider axis once the limits get surp - :ref:`float` **linear_limit/upper_distance** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The maximum difference between the pivot points on their X axis before damping happens. @@ -362,11 +398,13 @@ The maximum difference between the pivot points on their X axis before damping h - :ref:`float` **linear_motion/damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of damping inside the slider limits. @@ -374,11 +412,13 @@ The amount of damping inside the slider limits. - :ref:`float` **linear_motion/restitution** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.7 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of restitution inside the slider limits. @@ -386,11 +426,13 @@ The amount of restitution inside the slider limits. - :ref:`float` **linear_motion/softness** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. @@ -398,11 +440,13 @@ A factor applied to the movement across the slider axis as long as the slider is - :ref:`float` **linear_ortho/damping** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of damping when movement is across axes orthogonal to the slider. @@ -410,11 +454,13 @@ The amount of damping when movement is across axes orthogonal to the slider. - :ref:`float` **linear_ortho/restitution** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.7 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The amount of restitution when movement is across axes orthogonal to the slider. @@ -422,11 +468,13 @@ The amount of restitution when movement is across axes orthogonal to the slider. - :ref:`float` **linear_ortho/softness** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ A factor applied to the movement across axes orthogonal to the slider. diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst index ecf8edcfa..b03c5f1a6 100644 --- a/classes/class_softbody.rst +++ b/classes/class_softbody.rst @@ -19,31 +19,31 @@ A soft mesh physics body. Properties ---------- -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`areaAngular_stiffness` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_coefficient` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_coefficient` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_stiffness` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`parent_collision_ignore` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pose_matching_coefficient` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pressure_coefficient` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`simulation_precision` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`total_mass` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`volume_stiffness` | -+---------------------------------+-------------------------------------------------------------------------------------+ ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`areaAngular_stiffness` | 0.5 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`damping_coefficient` | 0.01 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`drag_coefficient` | 0.0 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`linear_stiffness` | 0.5 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`parent_collision_ignore` | NodePath("") | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`pose_matching_coefficient` | 0.0 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`pressure_coefficient` | 0.0 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`int` | :ref:`simulation_precision` | 5 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`total_mass` | 1.0 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ +| :ref:`float` | :ref:`volume_stiffness` | 0.5 | ++---------------------------------+-------------------------------------------------------------------------------------+--------------+ Methods ------- @@ -80,21 +80,25 @@ Property Descriptions - :ref:`float` **areaAngular_stiffness** -+----------+----------------------------------+ -| *Setter* | set_areaAngular_stiffness(value) | -+----------+----------------------------------+ -| *Getter* | get_areaAngular_stiffness() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | 0.5 | ++-----------+----------------------------------+ +| *Setter* | set_areaAngular_stiffness(value) | ++-----------+----------------------------------+ +| *Getter* | get_areaAngular_stiffness() | ++-----------+----------------------------------+ .. _class_SoftBody_property_collision_layer: - :ref:`int` **collision_layer** -+----------+----------------------------+ -| *Setter* | set_collision_layer(value) | -+----------+----------------------------+ -| *Getter* | get_collision_layer() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1 | ++-----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++-----------+----------------------------+ +| *Getter* | get_collision_layer() | ++-----------+----------------------------+ The physics layers this area is in. @@ -106,11 +110,13 @@ A contact is detected if object A is in any of the layers that object B scans, o - :ref:`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 for collisions. @@ -118,71 +124,85 @@ The physics layers this area scans for collisions. - :ref:`float` **damping_coefficient** -+----------+--------------------------------+ -| *Setter* | set_damping_coefficient(value) | -+----------+--------------------------------+ -| *Getter* | get_damping_coefficient() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.01 | ++-----------+--------------------------------+ +| *Setter* | set_damping_coefficient(value) | ++-----------+--------------------------------+ +| *Getter* | get_damping_coefficient() | ++-----------+--------------------------------+ .. _class_SoftBody_property_drag_coefficient: - :ref:`float` **drag_coefficient** -+----------+-----------------------------+ -| *Setter* | set_drag_coefficient(value) | -+----------+-----------------------------+ -| *Getter* | get_drag_coefficient() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_drag_coefficient(value) | ++-----------+-----------------------------+ +| *Getter* | get_drag_coefficient() | ++-----------+-----------------------------+ .. _class_SoftBody_property_linear_stiffness: - :ref:`float` **linear_stiffness** -+----------+-----------------------------+ -| *Setter* | set_linear_stiffness(value) | -+----------+-----------------------------+ -| *Getter* | get_linear_stiffness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.5 | ++-----------+-----------------------------+ +| *Setter* | set_linear_stiffness(value) | ++-----------+-----------------------------+ +| *Getter* | get_linear_stiffness() | ++-----------+-----------------------------+ .. _class_SoftBody_property_parent_collision_ignore: - :ref:`NodePath` **parent_collision_ignore** -+----------+------------------------------------+ -| *Setter* | set_parent_collision_ignore(value) | -+----------+------------------------------------+ -| *Getter* | get_parent_collision_ignore() | -+----------+------------------------------------+ ++-----------+------------------------------------+ +| *Default* | NodePath("") | ++-----------+------------------------------------+ +| *Setter* | set_parent_collision_ignore(value) | ++-----------+------------------------------------+ +| *Getter* | get_parent_collision_ignore() | ++-----------+------------------------------------+ .. _class_SoftBody_property_pose_matching_coefficient: - :ref:`float` **pose_matching_coefficient** -+----------+--------------------------------------+ -| *Setter* | set_pose_matching_coefficient(value) | -+----------+--------------------------------------+ -| *Getter* | get_pose_matching_coefficient() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------------------+ +| *Setter* | set_pose_matching_coefficient(value) | ++-----------+--------------------------------------+ +| *Getter* | get_pose_matching_coefficient() | ++-----------+--------------------------------------+ .. _class_SoftBody_property_pressure_coefficient: - :ref:`float` **pressure_coefficient** -+----------+---------------------------------+ -| *Setter* | set_pressure_coefficient(value) | -+----------+---------------------------------+ -| *Getter* | get_pressure_coefficient() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 0.0 | ++-----------+---------------------------------+ +| *Setter* | set_pressure_coefficient(value) | ++-----------+---------------------------------+ +| *Getter* | get_pressure_coefficient() | ++-----------+---------------------------------+ .. _class_SoftBody_property_simulation_precision: - :ref:`int` **simulation_precision** -+----------+---------------------------------+ -| *Setter* | set_simulation_precision(value) | -+----------+---------------------------------+ -| *Getter* | get_simulation_precision() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 5 | ++-----------+---------------------------------+ +| *Setter* | set_simulation_precision(value) | ++-----------+---------------------------------+ +| *Getter* | get_simulation_precision() | ++-----------+---------------------------------+ Increasing this value will improve the resulting simulation, but can affect performance. Use with care. @@ -190,21 +210,25 @@ Increasing this value will improve the resulting simulation, but can affect perf - :ref:`float` **total_mass** -+----------+-----------------------+ -| *Setter* | set_total_mass(value) | -+----------+-----------------------+ -| *Getter* | get_total_mass() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_total_mass(value) | ++-----------+-----------------------+ +| *Getter* | get_total_mass() | ++-----------+-----------------------+ .. _class_SoftBody_property_volume_stiffness: - :ref:`float` **volume_stiffness** -+----------+-----------------------------+ -| *Setter* | set_volume_stiffness(value) | -+----------+-----------------------------+ -| *Getter* | get_volume_stiffness() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.5 | ++-----------+-----------------------------+ +| *Setter* | set_volume_stiffness(value) | ++-----------+-----------------------------+ +| *Getter* | get_volume_stiffness() | ++-----------+-----------------------------+ Method Descriptions ------------------- diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index ef4e354ae..dd95fb93e 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -21,23 +21,23 @@ Most basic 3D game object, parent of all 3D-related nodes. Properties ---------- -+-----------------------------------------+------------------------------------------------------------------+ -| :ref:`SpatialGizmo` | :ref:`gizmo` | -+-----------------------------------------+------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`global_transform` | -+-----------------------------------------+------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`rotation` | -+-----------------------------------------+------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`rotation_degrees` | -+-----------------------------------------+------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`scale` | -+-----------------------------------------+------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`transform` | -+-----------------------------------------+------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`translation` | -+-----------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`visible` | -+-----------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`SpatialGizmo` | :ref:`gizmo` | | ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`global_transform` | | ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Vector3` | :ref:`rotation` | | ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Vector3` | :ref:`rotation_degrees` | Vector3( 0, 0, 0 ) | ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Vector3` | :ref:`scale` | Vector3( 1, 1, 1 ) | ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`transform` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Vector3` | :ref:`translation` | Vector3( 0, 0, 0 ) | ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`bool` | :ref:`visible` | true | ++-----------------------------------------+------------------------------------------------------------------+-------------------------------------------------+ Methods ------- @@ -197,11 +197,13 @@ Rotation part of the local transformation in radians, specified in terms of YXZ- - :ref:`Vector3` **rotation_degrees** -+----------+-----------------------------+ -| *Setter* | set_rotation_degrees(value) | -+----------+-----------------------------+ -| *Getter* | get_rotation_degrees() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+-----------------------------+ +| *Setter* | set_rotation_degrees(value) | ++-----------+-----------------------------+ +| *Getter* | get_rotation_degrees() | ++-----------+-----------------------------+ Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). @@ -209,11 +211,13 @@ Rotation part of the local transformation in degrees, specified in terms of YXZ- - :ref:`Vector3` **scale** -+----------+------------------+ -| *Setter* | set_scale(value) | -+----------+------------------+ -| *Getter* | get_scale() | -+----------+------------------+ ++-----------+--------------------+ +| *Default* | Vector3( 1, 1, 1 ) | ++-----------+--------------------+ +| *Setter* | set_scale(value) | ++-----------+--------------------+ +| *Getter* | get_scale() | ++-----------+--------------------+ Scale part of the local transformation. @@ -221,11 +225,13 @@ Scale part of the local transformation. - :ref:`Transform` **transform** -+----------+----------------------+ -| *Setter* | set_transform(value) | -+----------+----------------------+ -| *Getter* | get_transform() | -+----------+----------------------+ ++-----------+-------------------------------------------------+ +| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------+-------------------------------------------------+ +| *Setter* | set_transform(value) | ++-----------+-------------------------------------------------+ +| *Getter* | get_transform() | ++-----------+-------------------------------------------------+ Local space :ref:`Transform` of this node, with respect to the parent node. @@ -233,11 +239,13 @@ Local space :ref:`Transform` of this node, with respect to the - :ref:`Vector3` **translation** -+----------+------------------------+ -| *Setter* | set_translation(value) | -+----------+------------------------+ -| *Getter* | get_translation() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+------------------------+ +| *Setter* | set_translation(value) | ++-----------+------------------------+ +| *Getter* | get_translation() | ++-----------+------------------------+ Local translation of this node. @@ -245,13 +253,15 @@ Local translation of this node. - :ref:`bool` **visible** -+----------+--------------------+ -| *Setter* | set_visible(value) | -+----------+--------------------+ -| *Getter* | is_visible() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | true | ++-----------+--------------------+ +| *Setter* | set_visible(value) | ++-----------+--------------------+ +| *Getter* | is_visible() | ++-----------+--------------------+ -If ``true``, this node is drawn. Default value: ``true``. +If ``true``, this node is drawn. Method Descriptions ------------------- diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index e3de3b6ef..7896b1f4e 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -19,209 +19,209 @@ Default 3D rendering material. Properties ---------- -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`albedo_color` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`albedo_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anisotropy` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`anisotropy_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`anisotropy_flowmap` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ao_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ao_light_affect` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ao_on_uv2` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`ao_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`TextureChannel` | :ref:`ao_texture_channel` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`clearcoat` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`clearcoat_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`clearcoat_gloss` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`clearcoat_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`depth_deep_parallax` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`depth_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`depth_flip_binormal` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`depth_flip_tangent` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`depth_max_layers` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`depth_min_layers` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`depth_scale` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`depth_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`detail_albedo` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`BlendMode` | :ref:`detail_blend_mode` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`detail_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`detail_mask` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`detail_normal` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`DetailUV` | :ref:`detail_uv_layer` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_fade_max_distance` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_fade_min_distance` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`DistanceFadeMode` | :ref:`distance_fade_mode` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`emission` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emission_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_energy` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emission_on_uv2` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`EmissionOperator` | :ref:`emission_operator` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`emission_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_albedo_tex_force_srgb` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_disable_ambient_light` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_do_not_receive_shadows` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_ensure_correct_normals` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_fixed_size` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_no_depth_test` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_transparent` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_unshaded` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_use_point_size` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_use_shadow_to_opacity` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_vertex_lighting` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_world_triplanar` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`metallic` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`metallic_specular` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`metallic_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`TextureChannel` | :ref:`metallic_texture_channel` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`normal_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`normal_scale` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params_alpha_scissor_threshold` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`params_billboard_keep_scale` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`BillboardMode` | :ref:`params_billboard_mode` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`BlendMode` | :ref:`params_blend_mode` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`CullMode` | :ref:`params_cull_mode` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`DepthDrawMode` | :ref:`params_depth_draw_mode` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`DiffuseMode` | :ref:`params_diffuse_mode` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`params_grow` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params_grow_amount` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params_line_width` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params_point_size` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`SpecularMode` | :ref:`params_specular_mode` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`params_use_alpha_scissor` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_anim_h_frames` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_anim_loop` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_anim_v_frames` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`proximity_fade_distance` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`proximity_fade_enable` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`refraction_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`refraction_scale` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`refraction_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`TextureChannel` | :ref:`refraction_texture_channel` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rim` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rim_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`rim_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rim_tint` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`roughness` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`roughness_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`TextureChannel` | :ref:`roughness_texture_channel` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`subsurf_scatter_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`subsurf_scatter_strength` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`subsurf_scatter_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`transmission` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transmission_enabled` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`transmission_texture` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`uv1_offset` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`uv1_scale` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`uv1_triplanar` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`uv1_triplanar_sharpness` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`uv2_offset` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`uv2_scale` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`uv2_triplanar` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`uv2_triplanar_sharpness` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`vertex_color_is_srgb` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`vertex_color_use_as_albedo` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`albedo_color` | Color( 1, 1, 1, 1 ) | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`albedo_texture` | null | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`anisotropy` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`anisotropy_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`anisotropy_flowmap` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`ao_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`ao_light_affect` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`ao_on_uv2` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`ao_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`TextureChannel` | :ref:`ao_texture_channel` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`clearcoat` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`clearcoat_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`clearcoat_gloss` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`clearcoat_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`depth_deep_parallax` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`depth_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`depth_flip_binormal` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`depth_flip_tangent` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`depth_max_layers` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`depth_min_layers` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`depth_scale` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`depth_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`detail_albedo` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`BlendMode` | :ref:`detail_blend_mode` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`detail_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`detail_mask` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`detail_normal` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`DetailUV` | :ref:`detail_uv_layer` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`distance_fade_max_distance` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`distance_fade_min_distance` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`DistanceFadeMode` | :ref:`distance_fade_mode` | 0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`emission` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`emission_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`emission_energy` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`emission_on_uv2` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`EmissionOperator` | :ref:`emission_operator` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`emission_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_albedo_tex_force_srgb` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_disable_ambient_light` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_do_not_receive_shadows` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_ensure_correct_normals` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_fixed_size` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_no_depth_test` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_transparent` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_unshaded` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_use_point_size` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_use_shadow_to_opacity` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_vertex_lighting` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flags_world_triplanar` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`metallic` | 0.0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`metallic_specular` | 0.5 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`metallic_texture` | null | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`TextureChannel` | :ref:`metallic_texture_channel` | 2 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`normal_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`normal_scale` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`normal_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`params_alpha_scissor_threshold` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`params_billboard_keep_scale` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`BillboardMode` | :ref:`params_billboard_mode` | 0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`BlendMode` | :ref:`params_blend_mode` | 0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`CullMode` | :ref:`params_cull_mode` | 0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`DepthDrawMode` | :ref:`params_depth_draw_mode` | 0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`DiffuseMode` | :ref:`params_diffuse_mode` | 0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`params_grow` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`params_grow_amount` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`params_line_width` | 1.0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`params_point_size` | 1.0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`SpecularMode` | :ref:`params_specular_mode` | 0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`params_use_alpha_scissor` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`particles_anim_h_frames` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`particles_anim_loop` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`particles_anim_v_frames` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`proximity_fade_distance` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`proximity_fade_enable` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`refraction_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`refraction_scale` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`refraction_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`TextureChannel` | :ref:`refraction_texture_channel` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`rim` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`rim_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`rim_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`rim_tint` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`roughness` | 1.0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`roughness_texture` | null | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`TextureChannel` | :ref:`roughness_texture_channel` | 1 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`subsurf_scatter_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`subsurf_scatter_strength` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`subsurf_scatter_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`transmission` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`transmission_enabled` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`transmission_texture` | | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector3` | :ref:`uv1_offset` | Vector3( 0, 0, 0 ) | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector3` | :ref:`uv1_scale` | Vector3( 1, 1, 1 ) | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`uv1_triplanar` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`uv1_triplanar_sharpness` | 1.0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector3` | :ref:`uv2_offset` | Vector3( 0, 0, 0 ) | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector3` | :ref:`uv2_scale` | Vector3( 1, 1, 1 ) | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`uv2_triplanar` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`uv2_triplanar_sharpness` | 1.0 | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`vertex_color_is_srgb` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`vertex_color_use_as_albedo` | false | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+---------------------+ Enumerations ------------ @@ -566,7 +566,7 @@ enum **SpecularMode**: enum **BillboardMode**: -- **BILLBOARD_DISABLED** = **0** --- Default value. +- **BILLBOARD_DISABLED** = **0** --- Billboard mode is disabled. - **BILLBOARD_ENABLED** = **1** --- The object's Z axis will always face the camera. @@ -647,11 +647,13 @@ Property Descriptions - :ref:`Color` **albedo_color** -+----------+-------------------+ -| *Setter* | set_albedo(value) | -+----------+-------------------+ -| *Getter* | get_albedo() | -+----------+-------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_albedo(value) | ++-----------+---------------------+ +| *Getter* | get_albedo() | ++-----------+---------------------+ The material's base color. @@ -659,11 +661,13 @@ The material's base color. - :ref:`Texture` **albedo_texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ .. _class_SpatialMaterial_property_anisotropy: @@ -681,13 +685,15 @@ The strength of the anisotropy effect. - :ref:`bool` **anisotropy_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ -If ``true``, anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. Default value: ``false``. +If ``true``, anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. .. _class_SpatialMaterial_property_anisotropy_flowmap: @@ -703,11 +709,13 @@ If ``true``, anisotropy is enabled. Changes the shape of the specular blob and a - :ref:`bool` **ao_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ If ``true``, ambient occlusion is enabled. @@ -765,13 +773,15 @@ If ``true``, ambient occlusion is enabled. - :ref:`bool` **clearcoat_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ -If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass to the material. Default value: ``false``. +If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass to the material. .. _class_SpatialMaterial_property_clearcoat_gloss: @@ -807,11 +817,13 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t - :ref:`bool` **depth_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ If ``true``, depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also :ref:`normal_enabled`. @@ -899,11 +911,13 @@ If ``true``, depth mapping is enabled (also called "parallax mapping" or "height - :ref:`bool` **detail_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ .. _class_SpatialMaterial_property_detail_mask: @@ -959,11 +973,13 @@ If ``true``, depth mapping is enabled (also called "parallax mapping" or "height - :ref:`DistanceFadeMode` **distance_fade_mode** -+----------+--------------------------+ -| *Setter* | set_distance_fade(value) | -+----------+--------------------------+ -| *Getter* | get_distance_fade() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_distance_fade(value) | ++-----------+--------------------------+ +| *Getter* | get_distance_fade() | ++-----------+--------------------------+ .. _class_SpatialMaterial_property_emission: @@ -981,11 +997,13 @@ The emitted light's color. See :ref:`emission_enabled` **emission_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ If ``true``, the body emits light. @@ -1035,67 +1053,79 @@ The emitted light's strength. See :ref:`emission_enabled` **flags_albedo_tex_force_srgb** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ .. _class_SpatialMaterial_property_flags_disable_ambient_light: - :ref:`bool` **flags_disable_ambient_light** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, the object receives no ambient light. Default value: ``false``. +If ``true``, the object receives no ambient light. .. _class_SpatialMaterial_property_flags_do_not_receive_shadows: - :ref:`bool` **flags_do_not_receive_shadows** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, the object receives no shadow that would otherwise be cast onto it. Default value: ``false``. +If ``true``, the object receives no shadow that would otherwise be cast onto it. .. _class_SpatialMaterial_property_flags_ensure_correct_normals: - :ref:`bool` **flags_ensure_correct_normals** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ .. _class_SpatialMaterial_property_flags_fixed_size: - :ref:`bool` **flags_fixed_size** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, the object is rendered at the same size regardless of distance. Default value: ``false``. +If ``true``, the object is rendered at the same size regardless of distance. .. _class_SpatialMaterial_property_flags_no_depth_test: - :ref:`bool` **flags_no_depth_test** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ If ``true``, depth testing is disabled and the object will be drawn in render order. @@ -1103,35 +1133,41 @@ If ``true``, depth testing is disabled and the object will be drawn in render or - :ref:`bool` **flags_transparent** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ -If ``true``, transparency is enabled on the body. Default value: ``false``. See also :ref:`params_blend_mode`. +If ``true``, transparency is enabled on the body. See also :ref:`params_blend_mode`. .. _class_SpatialMaterial_property_flags_unshaded: - :ref:`bool` **flags_unshaded** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, the object is unaffected by lighting. Default value: ``false``. +If ``true``, the object is unaffected by lighting. .. _class_SpatialMaterial_property_flags_use_point_size: - :ref:`bool` **flags_use_point_size** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ If ``true``, render point size can be changed. @@ -1141,45 +1177,53 @@ If ``true``, render point size can be changed. - :ref:`bool` **flags_use_shadow_to_opacity** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ .. _class_SpatialMaterial_property_flags_vertex_lighting: - :ref:`bool` **flags_vertex_lighting** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: ``false``. +If ``true``, lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. .. _class_SpatialMaterial_property_flags_world_triplanar: - :ref:`bool` **flags_world_triplanar** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. Default value: ``false``. +If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. .. _class_SpatialMaterial_property_metallic: - :ref:`float` **metallic** -+----------+---------------------+ -| *Setter* | set_metallic(value) | -+----------+---------------------+ -| *Getter* | get_metallic() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_metallic(value) | ++-----------+---------------------+ +| *Getter* | get_metallic() | ++-----------+---------------------+ The reflectivity of the object's surface. The higher the value, the more light is reflected. @@ -1187,11 +1231,13 @@ The reflectivity of the object's surface. The higher the value, the more light i - :ref:`float` **metallic_specular** -+----------+---------------------+ -| *Setter* | set_specular(value) | -+----------+---------------------+ -| *Getter* | get_specular() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.5 | ++-----------+---------------------+ +| *Setter* | set_specular(value) | ++-----------+---------------------+ +| *Getter* | get_specular() | ++-----------+---------------------+ General reflectivity amount. @@ -1201,31 +1247,37 @@ General reflectivity amount. - :ref:`Texture` **metallic_texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ .. _class_SpatialMaterial_property_metallic_texture_channel: - :ref:`TextureChannel` **metallic_texture_channel** -+----------+-------------------------------------+ -| *Setter* | set_metallic_texture_channel(value) | -+----------+-------------------------------------+ -| *Getter* | get_metallic_texture_channel() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | 2 | ++-----------+-------------------------------------+ +| *Setter* | set_metallic_texture_channel(value) | ++-----------+-------------------------------------+ +| *Getter* | get_metallic_texture_channel() | ++-----------+-------------------------------------+ .. _class_SpatialMaterial_property_normal_enabled: - :ref:`bool` **normal_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ If ``true``, normal mapping is enabled. @@ -1265,21 +1317,25 @@ The strength of the normal map's effect. - :ref:`bool` **params_billboard_keep_scale** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ .. _class_SpatialMaterial_property_params_billboard_mode: - :ref:`BillboardMode` **params_billboard_mode** -+----------+---------------------------+ -| *Setter* | set_billboard_mode(value) | -+----------+---------------------------+ -| *Getter* | get_billboard_mode() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_billboard_mode(value) | ++-----------+---------------------------+ +| *Getter* | get_billboard_mode() | ++-----------+---------------------------+ Controls how the object faces the camera. See :ref:`BillboardMode`. @@ -1287,11 +1343,13 @@ Controls how the object faces the camera. See :ref:`BillboardMode` **params_blend_mode** -+----------+-----------------------+ -| *Setter* | set_blend_mode(value) | -+----------+-----------------------+ -| *Getter* | get_blend_mode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_blend_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_blend_mode() | ++-----------+-----------------------+ The material's blend mode. @@ -1301,11 +1359,13 @@ The material's blend mode. - :ref:`CullMode` **params_cull_mode** -+----------+----------------------+ -| *Setter* | set_cull_mode(value) | -+----------+----------------------+ -| *Getter* | get_cull_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_cull_mode(value) | ++-----------+----------------------+ +| *Getter* | get_cull_mode() | ++-----------+----------------------+ Which side of the object is not drawn when backfaces are rendered. See :ref:`CullMode`. @@ -1313,11 +1373,13 @@ Which side of the object is not drawn when backfaces are rendered. See :ref:`Cul - :ref:`DepthDrawMode` **params_depth_draw_mode** -+----------+----------------------------+ -| *Setter* | set_depth_draw_mode(value) | -+----------+----------------------------+ -| *Getter* | get_depth_draw_mode() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_depth_draw_mode(value) | ++-----------+----------------------------+ +| *Getter* | get_depth_draw_mode() | ++-----------+----------------------------+ Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`flags_transparent`. @@ -1325,11 +1387,13 @@ Determines when depth rendering takes place. See :ref:`DepthDrawMode` **params_diffuse_mode** -+----------+-------------------------+ -| *Setter* | set_diffuse_mode(value) | -+----------+-------------------------+ -| *Getter* | get_diffuse_mode() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_diffuse_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_diffuse_mode() | ++-----------+-------------------------+ The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. @@ -1337,11 +1401,13 @@ The algorithm used for diffuse light scattering. See :ref:`DiffuseMode` **params_grow** -+----------+-------------------------+ -| *Setter* | set_grow_enabled(value) | -+----------+-------------------------+ -| *Getter* | is_grow_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_grow_enabled(value) | ++-----------+-------------------------+ +| *Getter* | is_grow_enabled() | ++-----------+-------------------------+ If ``true``, enables the vertex grow setting. See :ref:`params_grow_amount`. @@ -1361,21 +1427,25 @@ Grows object vertices in the direction of their normals. - :ref:`float` **params_line_width** -+----------+-----------------------+ -| *Setter* | set_line_width(value) | -+----------+-----------------------+ -| *Getter* | get_line_width() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_line_width(value) | ++-----------+-----------------------+ +| *Getter* | get_line_width() | ++-----------+-----------------------+ .. _class_SpatialMaterial_property_params_point_size: - :ref:`float` **params_point_size** -+----------+-----------------------+ -| *Setter* | set_point_size(value) | -+----------+-----------------------+ -| *Getter* | get_point_size() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_point_size(value) | ++-----------+-----------------------+ +| *Getter* | get_point_size() | ++-----------+-----------------------+ The point size in pixels. See :ref:`flags_use_point_size`. @@ -1383,11 +1453,13 @@ The point size in pixels. See :ref:`flags_use_point_size` **params_specular_mode** -+----------+--------------------------+ -| *Setter* | set_specular_mode(value) | -+----------+--------------------------+ -| *Getter* | get_specular_mode() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_specular_mode(value) | ++-----------+--------------------------+ +| *Getter* | get_specular_mode() | ++-----------+--------------------------+ The method for rendering the specular blob. See :ref:`SpecularMode`. @@ -1395,11 +1467,13 @@ The method for rendering the specular blob. See :ref:`SpecularMode` **params_use_alpha_scissor** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ .. _class_SpatialMaterial_property_particles_anim_h_frames: @@ -1451,25 +1525,29 @@ The number of vertical frames in the particle sprite sheet. Only enabled when us - :ref:`bool` **proximity_fade_enable** -+----------+-----------------------------+ -| *Setter* | set_proximity_fade(value) | -+----------+-----------------------------+ -| *Getter* | is_proximity_fade_enabled() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | false | ++-----------+-----------------------------+ +| *Setter* | set_proximity_fade(value) | ++-----------+-----------------------------+ +| *Getter* | is_proximity_fade_enabled() | ++-----------+-----------------------------+ -If ``true``, the proximity and distance fade effect is enabled. Default value: ``false``. +If ``true``, the proximity and distance fade effect is enabled. .. _class_SpatialMaterial_property_refraction_enabled: - :ref:`bool` **refraction_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ -If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object. Default value: ``false``. +If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object. .. _class_SpatialMaterial_property_refraction_scale: @@ -1517,13 +1595,15 @@ The strength of the refraction effect. - :ref:`bool` **rim_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ -If ``true``, rim effect is enabled. Default value: ``false``. +If ``true``, rim effect is enabled. .. _class_SpatialMaterial_property_rim_texture: @@ -1551,11 +1631,13 @@ The amount of to blend light and albedo color when rendering rim effect. If ``0` - :ref:`float` **roughness** -+----------+----------------------+ -| *Setter* | set_roughness(value) | -+----------+----------------------+ -| *Getter* | get_roughness() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1.0 | ++-----------+----------------------+ +| *Setter* | set_roughness(value) | ++-----------+----------------------+ +| *Getter* | get_roughness() | ++-----------+----------------------+ Surface reflection. A value of ``0`` represents a perfect mirror while a value of ``1`` completely blurs the reflection. See also :ref:`metallic`. @@ -1563,31 +1645,37 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o - :ref:`Texture` **roughness_texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ .. _class_SpatialMaterial_property_roughness_texture_channel: - :ref:`TextureChannel` **roughness_texture_channel** -+----------+--------------------------------------+ -| *Setter* | set_roughness_texture_channel(value) | -+----------+--------------------------------------+ -| *Getter* | get_roughness_texture_channel() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | 1 | ++-----------+--------------------------------------+ +| *Setter* | set_roughness_texture_channel(value) | ++-----------+--------------------------------------+ +| *Getter* | get_roughness_texture_channel() | ++-----------+--------------------------------------+ .. _class_SpatialMaterial_property_subsurf_scatter_enabled: - :ref:`bool` **subsurf_scatter_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. @@ -1629,13 +1717,15 @@ The color used by the transmission effect. Represents the light passing through - :ref:`bool` **transmission_enabled** -+----------+--------------------+ -| *Setter* | set_feature(value) | -+----------+--------------------+ -| *Getter* | get_feature() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ -If ``true``, the transmission effect is enabled. Default value: ``false``. +If ``true``, the transmission effect is enabled. .. _class_SpatialMaterial_property_transmission_texture: @@ -1651,103 +1741,123 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. - :ref:`Vector3` **uv1_offset** -+----------+-----------------------+ -| *Setter* | set_uv1_offset(value) | -+----------+-----------------------+ -| *Getter* | get_uv1_offset() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+-----------------------+ +| *Setter* | set_uv1_offset(value) | ++-----------+-----------------------+ +| *Getter* | get_uv1_offset() | ++-----------+-----------------------+ .. _class_SpatialMaterial_property_uv1_scale: - :ref:`Vector3` **uv1_scale** -+----------+----------------------+ -| *Setter* | set_uv1_scale(value) | -+----------+----------------------+ -| *Getter* | get_uv1_scale() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Vector3( 1, 1, 1 ) | ++-----------+----------------------+ +| *Setter* | set_uv1_scale(value) | ++-----------+----------------------+ +| *Getter* | get_uv1_scale() | ++-----------+----------------------+ .. _class_SpatialMaterial_property_uv1_triplanar: - :ref:`bool` **uv1_triplanar** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ .. _class_SpatialMaterial_property_uv1_triplanar_sharpness: - :ref:`float` **uv1_triplanar_sharpness** -+----------+------------------------------------------+ -| *Setter* | set_uv1_triplanar_blend_sharpness(value) | -+----------+------------------------------------------+ -| *Getter* | get_uv1_triplanar_blend_sharpness() | -+----------+------------------------------------------+ ++-----------+------------------------------------------+ +| *Default* | 1.0 | ++-----------+------------------------------------------+ +| *Setter* | set_uv1_triplanar_blend_sharpness(value) | ++-----------+------------------------------------------+ +| *Getter* | get_uv1_triplanar_blend_sharpness() | ++-----------+------------------------------------------+ .. _class_SpatialMaterial_property_uv2_offset: - :ref:`Vector3` **uv2_offset** -+----------+-----------------------+ -| *Setter* | set_uv2_offset(value) | -+----------+-----------------------+ -| *Getter* | get_uv2_offset() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+-----------------------+ +| *Setter* | set_uv2_offset(value) | ++-----------+-----------------------+ +| *Getter* | get_uv2_offset() | ++-----------+-----------------------+ .. _class_SpatialMaterial_property_uv2_scale: - :ref:`Vector3` **uv2_scale** -+----------+----------------------+ -| *Setter* | set_uv2_scale(value) | -+----------+----------------------+ -| *Getter* | get_uv2_scale() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Vector3( 1, 1, 1 ) | ++-----------+----------------------+ +| *Setter* | set_uv2_scale(value) | ++-----------+----------------------+ +| *Getter* | get_uv2_scale() | ++-----------+----------------------+ .. _class_SpatialMaterial_property_uv2_triplanar: - :ref:`bool` **uv2_triplanar** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ .. _class_SpatialMaterial_property_uv2_triplanar_sharpness: - :ref:`float` **uv2_triplanar_sharpness** -+----------+------------------------------------------+ -| *Setter* | set_uv2_triplanar_blend_sharpness(value) | -+----------+------------------------------------------+ -| *Getter* | get_uv2_triplanar_blend_sharpness() | -+----------+------------------------------------------+ ++-----------+------------------------------------------+ +| *Default* | 1.0 | ++-----------+------------------------------------------+ +| *Setter* | set_uv2_triplanar_blend_sharpness(value) | ++-----------+------------------------------------------+ +| *Getter* | get_uv2_triplanar_blend_sharpness() | ++-----------+------------------------------------------+ .. _class_SpatialMaterial_property_vertex_color_is_srgb: - :ref:`bool` **vertex_color_is_srgb** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, the model's vertex colors are processed as sRGB mode. Default value: ``false``. +If ``true``, the model's vertex colors are processed as sRGB mode. .. _class_SpatialMaterial_property_vertex_color_use_as_albedo: - :ref:`bool` **vertex_color_use_as_albedo** -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | false | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ -If ``true``, the vertex color is used as albedo color. Default value: ``false``. +If ``true``, the vertex color is used as albedo color. diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index b81dd996d..55ee2d006 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_physics_step` | -+-------------------------+-------------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`track_physics_step` | false | ++-------------------------+-------------------------------------------------------------------------------------+-------+ Methods ------- @@ -41,11 +41,13 @@ Property Descriptions - :ref:`bool` **track_physics_step** -+----------+-------------------------------+ -| *Setter* | set_track_physics_step(value) | -+----------+-------------------------------+ -| *Getter* | is_tracking_physics_step() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | false | ++-----------+-------------------------------+ +| *Setter* | set_track_physics_step(value) | ++-----------+-------------------------------+ +| *Getter* | is_tracking_physics_step() | ++-----------+-------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index ce37e7acb..bd731f44a 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -19,17 +19,17 @@ Class representing a spherical :ref:`PrimitiveMesh`. Properties ---------- -+---------------------------+-------------------------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+-------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hemisphere` | -+---------------------------+-------------------------------------------------------------------+ -| :ref:`int` | :ref:`radial_segments` | -+---------------------------+-------------------------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+-------------------------------------------------------------------+ -| :ref:`int` | :ref:`rings` | -+---------------------------+-------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`height` | 2.0 | ++---------------------------+-------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`is_hemisphere` | false | ++---------------------------+-------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`radial_segments` | 64 | ++---------------------------+-------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`radius` | 1.0 | ++---------------------------+-------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`rings` | 32 | ++---------------------------+-------------------------------------------------------------------+-------+ Description ----------- @@ -43,61 +43,71 @@ Property Descriptions - :ref:`float` **height** -+----------+-------------------+ -| *Setter* | set_height(value) | -+----------+-------------------+ -| *Getter* | get_height() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 2.0 | ++-----------+-------------------+ +| *Setter* | set_height(value) | ++-----------+-------------------+ +| *Getter* | get_height() | ++-----------+-------------------+ -Full height of the sphere. Defaults to 2.0. +Full height of the sphere. .. _class_SphereMesh_property_is_hemisphere: - :ref:`bool` **is_hemisphere** -+----------+--------------------------+ -| *Setter* | set_is_hemisphere(value) | -+----------+--------------------------+ -| *Getter* | get_is_hemisphere() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_is_hemisphere(value) | ++-----------+--------------------------+ +| *Getter* | get_is_hemisphere() | ++-----------+--------------------------+ Determines whether a full sphere or a hemisphere is created. -**Note:** To get a regular hemisphere, the height and radius of the sphere must be equal. Defaults to ``false``. +**Note:** To get a regular hemisphere, the height and radius of the sphere must be equal. .. _class_SphereMesh_property_radial_segments: - :ref:`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 sphere. Defaults to 64. +Number of radial segments on the sphere. .. _class_SphereMesh_property_radius: - :ref:`float` **radius** -+----------+-------------------+ -| *Setter* | set_radius(value) | -+----------+-------------------+ -| *Getter* | get_radius() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ -Radius of sphere. Defaults to 1.0. +Radius of sphere. .. _class_SphereMesh_property_rings: - :ref:`int` **rings** -+----------+------------------+ -| *Setter* | set_rings(value) | -+----------+------------------+ -| *Getter* | get_rings() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 32 | ++-----------+------------------+ +| *Setter* | set_rings(value) | ++-----------+------------------+ +| *Getter* | get_rings() | ++-----------+------------------+ -Number of segments along the height of the sphere. Defaults to 32. +Number of segments along the height of the sphere. diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index fb739aae8..b76e8279d 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -19,9 +19,9 @@ Sphere shape for 3D collisions. Properties ---------- -+---------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+--------------------------------------------------+ ++---------------------------+--------------------------------------------------+-----+ +| :ref:`float` | :ref:`radius` | 1.0 | ++---------------------------+--------------------------------------------------+-----+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`float` **radius** -+----------+-------------------+ -| *Setter* | set_radius(value) | -+----------+-------------------+ -| *Getter* | get_radius() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ The sphere's radius. The shape's diameter is double the radius. diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index dfed9ca54..9ac751248 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -19,15 +19,15 @@ Numerical input text field. Properties ---------- -+-----------------------------------+--------------------------------------------------+ -| :ref:`Align` | :ref:`align` | -+-----------------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`editable` | -+-----------------------------------+--------------------------------------------------+ -| :ref:`String` | :ref:`prefix` | -+-----------------------------------+--------------------------------------------------+ -| :ref:`String` | :ref:`suffix` | -+-----------------------------------+--------------------------------------------------+ ++-----------------------------------+--------------------------------------------------+------+ +| :ref:`Align` | :ref:`align` | 0 | ++-----------------------------------+--------------------------------------------------+------+ +| :ref:`bool` | :ref:`editable` | true | ++-----------------------------------+--------------------------------------------------+------+ +| :ref:`String` | :ref:`prefix` | "" | ++-----------------------------------+--------------------------------------------------+------+ +| :ref:`String` | :ref:`suffix` | "" | ++-----------------------------------+--------------------------------------------------+------+ Methods ------- @@ -69,11 +69,13 @@ Property Descriptions - :ref:`Align` **align** -+----------+------------------+ -| *Setter* | set_align(value) | -+----------+------------------+ -| *Getter* | get_align() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_align(value) | ++-----------+------------------+ +| *Getter* | get_align() | ++-----------+------------------+ Sets the text alignment of the ``SpinBox``. @@ -81,11 +83,13 @@ Sets the text alignment of the ``SpinBox``. - :ref:`bool` **editable** -+----------+---------------------+ -| *Setter* | set_editable(value) | -+----------+---------------------+ -| *Getter* | is_editable() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_editable(value) | ++-----------+---------------------+ +| *Getter* | is_editable() | ++-----------+---------------------+ If ``true``, the ``SpinBox`` will be editable. Otherwise, it will be read only. @@ -93,11 +97,13 @@ If ``true``, the ``SpinBox`` will be editable. Otherwise, it will be read only. - :ref:`String` **prefix** -+----------+-------------------+ -| *Setter* | set_prefix(value) | -+----------+-------------------+ -| *Getter* | get_prefix() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | "" | ++-----------+-------------------+ +| *Setter* | set_prefix(value) | ++-----------+-------------------+ +| *Getter* | get_prefix() | ++-----------+-------------------+ Adds the specified ``prefix`` string before the numerical value of the ``SpinBox``. @@ -105,11 +111,13 @@ Adds the specified ``prefix`` string before the numerical value of the ``SpinBox - :ref:`String` **suffix** -+----------+-------------------+ -| *Setter* | set_suffix(value) | -+----------+-------------------+ -| *Getter* | get_suffix() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | "" | ++-----------+-------------------+ +| *Setter* | set_suffix(value) | ++-----------+-------------------+ +| *Getter* | get_suffix() | ++-----------+-------------------+ Adds the specified ``prefix`` string after the numerical value of the ``SpinBox``. diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index c1d018338..f58ecc557 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -21,13 +21,13 @@ Container for splitting and adjusting. Properties ---------- -+-----------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collapsed` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`DraggerVisibility` | :ref:`dragger_visibility` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`split_offset` | -+-----------------------------------------------------------------+-----------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`collapsed` | false | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`DraggerVisibility` | :ref:`dragger_visibility` | 0 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`split_offset` | 0 | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+-------+ Methods ------- @@ -76,21 +76,25 @@ Property Descriptions - :ref:`bool` **collapsed** -+----------+----------------------+ -| *Setter* | set_collapsed(value) | -+----------+----------------------+ -| *Getter* | is_collapsed() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_collapsed(value) | ++-----------+----------------------+ +| *Getter* | is_collapsed() | ++-----------+----------------------+ .. _class_SplitContainer_property_dragger_visibility: - :ref:`DraggerVisibility` **dragger_visibility** -+----------+-------------------------------+ -| *Setter* | set_dragger_visibility(value) | -+----------+-------------------------------+ -| *Getter* | get_dragger_visibility() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0 | ++-----------+-------------------------------+ +| *Setter* | set_dragger_visibility(value) | ++-----------+-------------------------------+ +| *Getter* | get_dragger_visibility() | ++-----------+-------------------------------+ Determines whether the dragger is visible. @@ -98,11 +102,13 @@ Determines whether the dragger is visible. - :ref:`int` **split_offset** -+----------+-------------------------+ -| *Setter* | set_split_offset(value) | -+----------+-------------------------+ -| *Getter* | get_split_offset() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_split_offset(value) | ++-----------+-------------------------+ +| *Getter* | get_split_offset() | ++-----------+-------------------------+ Method Descriptions ------------------- diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index aaed3b8c2..8dd9f6a24 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -19,15 +19,15 @@ A spotlight, such as a reflector spotlight or a lantern. Properties ---------- -+---------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spot_angle` | -+---------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spot_angle_attenuation` | -+---------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spot_attenuation` | -+---------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spot_range` | -+---------------------------+--------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`spot_angle` | 45.0 | ++---------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`spot_angle_attenuation` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`spot_attenuation` | 1.0 | ++---------------------------+--------------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`spot_range` | 5.0 | ++---------------------------+--------------------------------------------------------------------------------+------+ Description ----------- @@ -46,11 +46,13 @@ Property Descriptions - :ref:`float` **spot_angle** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 45.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The spotlight's angle in degrees. @@ -58,11 +60,13 @@ The spotlight's angle in degrees. - :ref:`float` **spot_angle_attenuation** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The spotlight's angular attenuation curve. @@ -70,11 +74,13 @@ The spotlight's angular attenuation curve. - :ref:`float` **spot_attenuation** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The spotlight's light energy attenuation curve. @@ -82,11 +88,13 @@ The spotlight's light energy attenuation curve. - :ref:`float` **spot_range** -+----------+------------------+ -| *Setter* | set_param(value) | -+----------+------------------+ -| *Getter* | get_param() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 5.0 | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ The maximal range that can be reached by the spotlight. diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index 672b9d7dc..25edec014 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -19,15 +19,15 @@ Brief Description Properties ---------- -+---------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+---------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+---------------------------+----------------------------------------------------------------+ -| :ref:`Shape` | :ref:`shape` | -+---------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`spring_length` | -+---------------------------+----------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------+------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++---------------------------+----------------------------------------------------------------+------+ +| :ref:`float` | :ref:`margin` | 0.01 | ++---------------------------+----------------------------------------------------------------+------+ +| :ref:`Shape` | :ref:`shape` | null | ++---------------------------+----------------------------------------------------------------+------+ +| :ref:`float` | :ref:`spring_length` | 1.0 | ++---------------------------+----------------------------------------------------------------+------+ Methods ------- @@ -49,41 +49,49 @@ Property Descriptions - :ref:`int` **collision_mask** -+----------+---------------------------+ -| *Setter* | set_collision_mask(value) | -+----------+---------------------------+ -| *Getter* | get_collision_mask() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_collision_mask() | ++-----------+---------------------------+ .. _class_SpringArm_property_margin: - :ref:`float` **margin** -+----------+-------------------+ -| *Setter* | set_margin(value) | -+----------+-------------------+ -| *Getter* | get_margin() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.01 | ++-----------+-------------------+ +| *Setter* | set_margin(value) | ++-----------+-------------------+ +| *Getter* | get_margin() | ++-----------+-------------------+ .. _class_SpringArm_property_shape: - :ref:`Shape` **shape** -+----------+------------------+ -| *Setter* | set_shape(value) | -+----------+------------------+ -| *Getter* | get_shape() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | null | ++-----------+------------------+ +| *Setter* | set_shape(value) | ++-----------+------------------+ +| *Getter* | get_shape() | ++-----------+------------------+ .. _class_SpringArm_property_spring_length: - :ref:`float` **spring_length** -+----------+-------------------+ -| *Setter* | set_length(value) | -+----------+-------------------+ -| *Getter* | get_length() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 1.0 | ++-----------+-------------------+ +| *Setter* | set_length(value) | ++-----------+-------------------+ +| *Getter* | get_length() | ++-----------+-------------------+ Method Descriptions ------------------- diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 72fccfe9c..343ade962 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -19,31 +19,31 @@ General-purpose sprite node. Properties ---------- -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`centered` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_h` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_v` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`frame` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`hframes` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`region_enabled` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`region_filter_clip` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`vframes` | -+-------------------------------+---------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`centered` | true | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flip_h` | false | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flip_v` | false | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`frame` | 0 | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`hframes` | 1 | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`normal_map` | null | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`region_enabled` | false | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`region_filter_clip` | false | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`Rect2` | :ref:`region_rect` | Rect2( 0, 0, 0, 0 ) | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++-------------------------------+---------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`vframes` | 1 | ++-------------------------------+---------------------------------------------------------------------+---------------------+ Methods ------- @@ -81,47 +81,55 @@ Property Descriptions - :ref:`bool` **centered** -+----------+---------------------+ -| *Setter* | set_centered(value) | -+----------+---------------------+ -| *Getter* | is_centered() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_centered(value) | ++-----------+---------------------+ +| *Getter* | is_centered() | ++-----------+---------------------+ -If ``true``, texture is centered. Default value: ``true``. +If ``true``, texture is centered. .. _class_Sprite_property_flip_h: - :ref:`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_Sprite_property_flip_v: - :ref:`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_Sprite_property_frame: - :ref:`int` **frame** -+----------+------------------+ -| *Setter* | set_frame(value) | -+----------+------------------+ -| *Getter* | get_frame() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_frame(value) | ++-----------+------------------+ +| *Getter* | get_frame() | ++-----------+------------------+ Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. @@ -129,11 +137,13 @@ Current frame to display from sprite sheet. :ref:`vframes` **hframes** -+----------+--------------------+ -| *Setter* | set_hframes(value) | -+----------+--------------------+ -| *Getter* | get_hframes() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1 | ++-----------+--------------------+ +| *Setter* | set_hframes(value) | ++-----------+--------------------+ +| *Getter* | get_hframes() | ++-----------+--------------------+ The number of columns in the sprite sheet. @@ -141,11 +151,13 @@ The number of columns in the sprite sheet. - :ref:`Texture` **normal_map** -+----------+-----------------------+ -| *Setter* | set_normal_map(value) | -+----------+-----------------------+ -| *Getter* | get_normal_map() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++-----------+-----------------------+ +| *Getter* | get_normal_map() | ++-----------+-----------------------+ The normal map gives depth to the Sprite. @@ -153,11 +165,13 @@ The normal map gives depth to the Sprite. - :ref:`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. @@ -165,23 +179,27 @@ The texture's drawing offset. - :ref:`bool` **region_enabled** -+----------+-------------------+ -| *Setter* | set_region(value) | -+----------+-------------------+ -| *Getter* | is_region() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_region(value) | ++-----------+-------------------+ +| *Getter* | is_region() | ++-----------+-------------------+ -If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. +If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`. .. _class_Sprite_property_region_filter_clip: - :ref:`bool` **region_filter_clip** -+----------+---------------------------------+ -| *Setter* | set_region_filter_clip(value) | -+----------+---------------------------------+ -| *Getter* | is_region_filter_clip_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_region_filter_clip(value) | ++-----------+---------------------------------+ +| *Getter* | is_region_filter_clip_enabled() | ++-----------+---------------------------------+ If ``true``, the outermost pixels get blurred out. @@ -189,11 +207,13 @@ If ``true``, the outermost pixels get blurred out. - :ref:`Rect2` **region_rect** -+----------+------------------------+ -| *Setter* | set_region_rect(value) | -+----------+------------------------+ -| *Getter* | get_region_rect() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Rect2( 0, 0, 0, 0 ) | ++-----------+------------------------+ +| *Setter* | set_region_rect(value) | ++-----------+------------------------+ +| *Getter* | get_region_rect() | ++-----------+------------------------+ The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. @@ -201,11 +221,13 @@ The region of the atlas texture to display. :ref:`region_enabled` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ :ref:`Texture` object to draw. @@ -213,11 +235,13 @@ The region of the atlas texture to display. :ref:`region_enabled` **vframes** -+----------+--------------------+ -| *Setter* | set_vframes(value) | -+----------+--------------------+ -| *Getter* | get_vframes() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1 | ++-----------+--------------------+ +| *Setter* | set_vframes(value) | ++-----------+--------------------+ +| *Getter* | get_vframes() | ++-----------+--------------------+ The number of rows in the sprite sheet. diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 88fca7acb..f2dc944fd 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -19,19 +19,19 @@ Brief Description Properties ---------- -+-------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`frame` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`hframes` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`region_enabled` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`vframes` | -+-------------------------------+---------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`frame` | 0 | ++-------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`hframes` | 1 | ++-------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`region_enabled` | false | ++-------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`Rect2` | :ref:`region_rect` | Rect2( 0, 0, 0, 0 ) | ++-------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++-------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`vframes` | 1 | ++-------------------------------+---------------------------------------------------------------+---------------------+ Signals ------- @@ -54,11 +54,13 @@ Property Descriptions - :ref:`int` **frame** -+----------+------------------+ -| *Setter* | set_frame(value) | -+----------+------------------+ -| *Getter* | get_frame() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_frame(value) | ++-----------+------------------+ +| *Getter* | get_frame() | ++-----------+------------------+ Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. @@ -66,11 +68,13 @@ Current frame to display from sprite sheet. :ref:`vframes` **hframes** -+----------+--------------------+ -| *Setter* | set_hframes(value) | -+----------+--------------------+ -| *Getter* | get_hframes() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1 | ++-----------+--------------------+ +| *Setter* | set_hframes(value) | ++-----------+--------------------+ +| *Getter* | get_hframes() | ++-----------+--------------------+ The number of columns in the sprite sheet. @@ -78,23 +82,27 @@ The number of columns in the sprite sheet. - :ref:`bool` **region_enabled** -+----------+-------------------+ -| *Setter* | set_region(value) | -+----------+-------------------+ -| *Getter* | is_region() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_region(value) | ++-----------+-------------------+ +| *Getter* | is_region() | ++-----------+-------------------+ -If ``true``, texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. +If ``true``, texture will be cut from a larger atlas texture. See :ref:`region_rect`. .. _class_Sprite3D_property_region_rect: - :ref:`Rect2` **region_rect** -+----------+------------------------+ -| *Setter* | set_region_rect(value) | -+----------+------------------------+ -| *Getter* | get_region_rect() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Rect2( 0, 0, 0, 0 ) | ++-----------+------------------------+ +| *Setter* | set_region_rect(value) | ++-----------+------------------------+ +| *Getter* | get_region_rect() | ++-----------+------------------------+ The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. @@ -102,11 +110,13 @@ The region of the atlas texture to display. :ref:`region_enabled` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ :ref:`Texture` object to draw. @@ -114,11 +124,13 @@ The region of the atlas texture to display. :ref:`region_enabled` **vframes** -+----------+--------------------+ -| *Setter* | set_vframes(value) | -+----------+--------------------+ -| *Getter* | get_vframes() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1 | ++-----------+--------------------+ +| *Setter* | set_vframes(value) | ++-----------+--------------------+ +| *Getter* | get_vframes() | ++-----------+--------------------+ The number of rows in the sprite sheet. diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 6d5575199..26729d183 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -21,31 +21,31 @@ Brief Description Properties ---------- -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`AlphaCutMode` | :ref:`alpha_cut` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| Vector3.Axis | :ref:`axis` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`centered` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`double_sided` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_h` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_v` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Color` | :ref:`modulate` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`opacity` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`pixel_size` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaded` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`transparent` | -+-----------------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`AlphaCutMode` | :ref:`alpha_cut` | 0 | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| Vector3.Axis | :ref:`axis` | 2 | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`centered` | true | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`double_sided` | true | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flip_h` | false | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`flip_v` | false | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`modulate` | Color( 1, 1, 1, 1 ) | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`offset` | Vector2( 0, 0 ) | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`opacity` | 1.0 | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`pixel_size` | 0.01 | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`shaded` | false | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`transparent` | true | ++-----------------------------------------------------+---------------------------------------------------------------+---------------------+ Methods ------- @@ -107,21 +107,25 @@ Property Descriptions - :ref:`AlphaCutMode` **alpha_cut** -+----------+---------------------------+ -| *Setter* | set_alpha_cut_mode(value) | -+----------+---------------------------+ -| *Getter* | get_alpha_cut_mode() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_alpha_cut_mode(value) | ++-----------+---------------------------+ +| *Getter* | get_alpha_cut_mode() | ++-----------+---------------------------+ .. _class_SpriteBase3D_property_axis: - Vector3.Axis **axis** -+----------+-----------------+ -| *Setter* | set_axis(value) | -+----------+-----------------+ -| *Getter* | get_axis() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 2 | ++-----------+-----------------+ +| *Setter* | set_axis(value) | ++-----------+-----------------+ +| *Getter* | get_axis() | ++-----------+-----------------+ The direction in which the front of the texture faces. @@ -129,59 +133,69 @@ The direction in which the front of the texture faces. - :ref:`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_SpriteBase3D_property_double_sided: - :ref:`bool` **double_sided** -+----------+----------------------+ -| *Setter* | set_draw_flag(value) | -+----------+----------------------+ -| *Getter* | get_draw_flag() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_draw_flag(value) | ++-----------+----------------------+ +| *Getter* | get_draw_flag() | ++-----------+----------------------+ -If ``true``, texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. Default value: ``true``. +If ``true``, texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. .. _class_SpriteBase3D_property_flip_h: - :ref:`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_SpriteBase3D_property_flip_v: - :ref:`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_SpriteBase3D_property_modulate: - :ref:`Color` **modulate** -+----------+---------------------+ -| *Setter* | set_modulate(value) | -+----------+---------------------+ -| *Getter* | get_modulate() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_modulate(value) | ++-----------+---------------------+ +| *Getter* | get_modulate() | ++-----------+---------------------+ A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. @@ -189,11 +203,13 @@ A color value that gets multiplied on, could be used for mood-coloring or to sim - :ref:`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. @@ -201,11 +217,13 @@ The texture's drawing offset. - :ref:`float` **opacity** -+----------+--------------------+ -| *Setter* | set_opacity(value) | -+----------+--------------------+ -| *Getter* | get_opacity() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1.0 | ++-----------+--------------------+ +| *Setter* | set_opacity(value) | ++-----------+--------------------+ +| *Getter* | get_opacity() | ++-----------+--------------------+ The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. @@ -213,11 +231,13 @@ The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visi - :ref:`float` **pixel_size** -+----------+-----------------------+ -| *Setter* | set_pixel_size(value) | -+----------+-----------------------+ -| *Getter* | get_pixel_size() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0.01 | ++-----------+-----------------------+ +| *Setter* | set_pixel_size(value) | ++-----------+-----------------------+ +| *Getter* | get_pixel_size() | ++-----------+-----------------------+ The size of one pixel's width on the sprite to scale it in 3D. @@ -225,25 +245,29 @@ The size of one pixel's width on the sprite to scale it in 3D. - :ref:`bool` **shaded** -+----------+----------------------+ -| *Setter* | set_draw_flag(value) | -+----------+----------------------+ -| *Getter* | get_draw_flag() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_draw_flag(value) | ++-----------+----------------------+ +| *Getter* | get_draw_flag() | ++-----------+----------------------+ -If ``true``, the :ref:`Light` in the :ref:`Environment` has effects on the sprite. Default value: ``false``. +If ``true``, the :ref:`Light` in the :ref:`Environment` has effects on the sprite. .. _class_SpriteBase3D_property_transparent: - :ref:`bool` **transparent** -+----------+----------------------+ -| *Setter* | set_draw_flag(value) | -+----------+----------------------+ -| *Getter* | get_draw_flag() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_draw_flag(value) | ++-----------+----------------------+ +| *Getter* | get_draw_flag() | ++-----------+----------------------+ -If ``true``, the texture's transparency and the opacity are used to make those parts of the sprite invisible. Default value: ``true``. +If ``true``, the texture's transparency and the opacity are used to make those parts of the sprite invisible. Method Descriptions ------------------- diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 5d0346a95..a15570280 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -19,17 +19,17 @@ Static body for 3D physics. Properties ---------- -+-----------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`constant_angular_velocity` | -+-----------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`constant_linear_velocity` | -+-----------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | -+-----------------------------------------------+---------------------------------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`bounce` | | ++-----------------------------------------------+---------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`constant_angular_velocity` | Vector3( 0, 0, 0 ) | ++-----------------------------------------------+---------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`constant_linear_velocity` | Vector3( 0, 0, 0 ) | ++-----------------------------------------------+---------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`friction` | | ++-----------------------------------------------+---------------------------------------------------------------------------------------+--------------------+ +| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | null | ++-----------------------------------------------+---------------------------------------------------------------------------------------+--------------------+ Description ----------- @@ -53,17 +53,21 @@ Property Descriptions | *Getter* | get_bounce() | +----------+-------------------+ -The body's bounciness. +The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). + +Deprecated, use :ref:`PhysicsMaterial.bounce` instead via :ref:`physics_material_override`. .. _class_StaticBody_property_constant_angular_velocity: - :ref:`Vector3` **constant_angular_velocity** -+----------+--------------------------------------+ -| *Setter* | set_constant_angular_velocity(value) | -+----------+--------------------------------------+ -| *Getter* | get_constant_angular_velocity() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------------------------+ +| *Setter* | set_constant_angular_velocity(value) | ++-----------+--------------------------------------+ +| *Getter* | get_constant_angular_velocity() | ++-----------+--------------------------------------+ The body's constant angular velocity. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. @@ -71,11 +75,13 @@ The body's constant angular velocity. This does not rotate the body, but affects - :ref:`Vector3` **constant_linear_velocity** -+----------+-------------------------------------+ -| *Setter* | set_constant_linear_velocity(value) | -+----------+-------------------------------------+ -| *Getter* | get_constant_linear_velocity() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+-------------------------------------+ +| *Setter* | set_constant_linear_velocity(value) | ++-----------+-------------------------------------+ +| *Getter* | get_constant_linear_velocity() | ++-----------+-------------------------------------+ The body's constant linear velocity. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. @@ -91,13 +97,17 @@ The body's constant linear velocity. This does not move the body, but affects ot The body's friction, from 0 (frictionless) to 1 (full friction). +Deprecated, use :ref:`PhysicsMaterial.friction` instead via :ref:`physics_material_override`. + .. _class_StaticBody_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** -+----------+--------------------------------------+ -| *Setter* | set_physics_material_override(value) | -+----------+--------------------------------------+ -| *Getter* | get_physics_material_override() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | null | ++-----------+--------------------------------------+ +| *Setter* | set_physics_material_override(value) | ++-----------+--------------------------------------+ +| *Getter* | get_physics_material_override() | ++-----------+--------------------------------------+ diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 201b1aeb3..9d13bdf58 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -19,17 +19,17 @@ Static body for 2D physics. Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`constant_angular_velocity` | -+-----------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`constant_linear_velocity` | -+-----------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | -+-----------------------------------------------+-----------------------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`bounce` | | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`constant_angular_velocity` | 0.0 | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`constant_linear_velocity` | Vector2( 0, 0 ) | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`float` | :ref:`friction` | | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | null | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ Description ----------- @@ -53,15 +53,19 @@ Property Descriptions The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). +Deprecated, use :ref:`PhysicsMaterial.bounce` instead via :ref:`physics_material_override`. + .. _class_StaticBody2D_property_constant_angular_velocity: - :ref:`float` **constant_angular_velocity** -+----------+--------------------------------------+ -| *Setter* | set_constant_angular_velocity(value) | -+----------+--------------------------------------+ -| *Getter* | get_constant_angular_velocity() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------------------+ +| *Setter* | set_constant_angular_velocity(value) | ++-----------+--------------------------------------+ +| *Getter* | get_constant_angular_velocity() | ++-----------+--------------------------------------+ The body's constant angular velocity. This does not rotate the body, but affects colliding bodies, as if it were rotating. @@ -69,11 +73,13 @@ The body's constant angular velocity. This does not rotate the body, but affects - :ref:`Vector2` **constant_linear_velocity** -+----------+-------------------------------------+ -| *Setter* | set_constant_linear_velocity(value) | -+----------+-------------------------------------+ -| *Getter* | get_constant_linear_velocity() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-------------------------------------+ +| *Setter* | set_constant_linear_velocity(value) | ++-----------+-------------------------------------+ +| *Getter* | get_constant_linear_velocity() | ++-----------+-------------------------------------+ The body's constant linear velocity. This does not move the body, but affects colliding bodies, as if it were moving. @@ -89,13 +95,17 @@ The body's constant linear velocity. This does not move the body, but affects co The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). +Deprecated, use :ref:`PhysicsMaterial.friction` instead via :ref:`physics_material_override`. + .. _class_StaticBody2D_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** -+----------+--------------------------------------+ -| *Setter* | set_physics_material_override(value) | -+----------+--------------------------------------+ -| *Getter* | get_physics_material_override() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | null | ++-----------+--------------------------------------+ +| *Setter* | set_physics_material_override(value) | ++-----------+--------------------------------------+ +| *Getter* | get_physics_material_override() | ++-----------+--------------------------------------+ diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 58d1de7bc..1880587aa 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -21,9 +21,9 @@ Abstraction and base class for stream-based protocols. Properties ---------- -+-------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`big_endian` | -+-------------------------+---------------------------------------------------------+ ++-------------------------+---------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`big_endian` | false | ++-------------------------+---------------------------------------------------------+-------+ Methods ------- @@ -104,11 +104,13 @@ Property Descriptions - :ref:`bool` **big_endian** -+----------+-------------------------+ -| *Setter* | set_big_endian(value) | -+----------+-------------------------+ -| *Getter* | is_big_endian_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_big_endian(value) | ++-----------+-------------------------+ +| *Getter* | is_big_endian_enabled() | ++-----------+-------------------------+ If ``true``, this ``StreamPeer`` will using big-endian format for encoding and decoding. diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 647d9b765..78ab809c2 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------------------------+---------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`data_array` | -+-------------------------------------------+---------------------------------------------------------------+ ++-------------------------------------------+---------------------------------------------------------------+-------------------+ +| :ref:`PoolByteArray` | :ref:`data_array` | PoolByteArray( ) | ++-------------------------------------------+---------------------------------------------------------------+-------------------+ Methods ------- @@ -47,11 +47,13 @@ Property Descriptions - :ref:`PoolByteArray` **data_array** -+----------+-----------------------+ -| *Setter* | set_data_array(value) | -+----------+-----------------------+ -| *Getter* | get_data_array() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | PoolByteArray( ) | ++-----------+-----------------------+ +| *Setter* | set_data_array(value) | ++-----------+-----------------------+ +| *Getter* | get_data_array() | ++-----------+-----------------------+ Method Descriptions ------------------- diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 08b7027f1..21b95e3d0 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -19,9 +19,9 @@ SSL stream peer. Properties ---------- -+-------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`blocking_handshake` | -+-------------------------+----------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`blocking_handshake` | true | ++-------------------------+----------------------------------------------------------------------------+------+ Methods ------- @@ -82,11 +82,13 @@ Property Descriptions - :ref:`bool` **blocking_handshake** -+----------+---------------------------------------+ -| *Setter* | set_blocking_handshake_enabled(value) | -+----------+---------------------------------------+ -| *Getter* | is_blocking_handshake_enabled() | -+----------+---------------------------------------+ ++-----------+---------------------------------------+ +| *Default* | true | ++-----------+---------------------------------------+ +| *Setter* | set_blocking_handshake_enabled(value) | ++-----------+---------------------------------------+ +| *Getter* | is_blocking_handshake_enabled() | ++-----------+---------------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index f81b0a240..24e941b51 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -19,9 +19,9 @@ A ``.stex`` texture. Properties ---------- -+-----------------------------+----------------------------------------------------------+ -| :ref:`String` | :ref:`load_path` | -+-----------------------------+----------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------+----+ +| :ref:`String` | :ref:`load_path` | "" | ++-----------------------------+----------------------------------------------------------+----+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`String` **load_path** -+----------+-----------------+ -| *Setter* | load(value) | -+----------+-----------------+ -| *Getter* | get_load_path() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | load(value) | ++-----------+-----------------+ +| *Getter* | get_load_path() | ++-----------+-----------------+ The StreamTexture's file path to a ``.stex`` file. diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index f6e484bc5..e9356e40b 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -21,15 +21,15 @@ Base class for drawing stylized boxes for the UI. Properties ---------- -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`content_margin_bottom` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`content_margin_left` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`content_margin_right` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`content_margin_top` | -+---------------------------+-----------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`content_margin_bottom` | -1.0 | ++---------------------------+-----------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`content_margin_left` | -1.0 | ++---------------------------+-----------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`content_margin_right` | -1.0 | ++---------------------------+-----------------------------------------------------------------------------+------+ +| :ref:`float` | :ref:`content_margin_top` | -1.0 | ++---------------------------+-----------------------------------------------------------------------------+------+ Methods ------- @@ -62,11 +62,13 @@ Property Descriptions - :ref:`float` **content_margin_bottom** -+----------+---------------------------+ -| *Setter* | set_default_margin(value) | -+----------+---------------------------+ -| *Getter* | get_default_margin() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | -1.0 | ++-----------+---------------------------+ +| *Setter* | set_default_margin(value) | ++-----------+---------------------------+ +| *Getter* | get_default_margin() | ++-----------+---------------------------+ The bottom margin for the contents of this style box. Increasing this value reduces the space available to the contents from the bottom. @@ -80,11 +82,13 @@ It is up to the code using this style box to decide what these contents are: for - :ref:`float` **content_margin_left** -+----------+---------------------------+ -| *Setter* | set_default_margin(value) | -+----------+---------------------------+ -| *Getter* | get_default_margin() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | -1.0 | ++-----------+---------------------------+ +| *Setter* | set_default_margin(value) | ++-----------+---------------------------+ +| *Getter* | get_default_margin() | ++-----------+---------------------------+ The left margin for the contents of this style box. Increasing this value reduces the space available to the contents from the left. @@ -94,11 +98,13 @@ Refer to :ref:`content_margin_bottom` **content_margin_right** -+----------+---------------------------+ -| *Setter* | set_default_margin(value) | -+----------+---------------------------+ -| *Getter* | get_default_margin() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | -1.0 | ++-----------+---------------------------+ +| *Setter* | set_default_margin(value) | ++-----------+---------------------------+ +| *Getter* | get_default_margin() | ++-----------+---------------------------+ The right margin for the contents of this style box. Increasing this value reduces the space available to the contents from the right. @@ -108,11 +114,13 @@ Refer to :ref:`content_margin_bottom` **content_margin_top** -+----------+---------------------------+ -| *Setter* | set_default_margin(value) | -+----------+---------------------------+ -| *Getter* | get_default_margin() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | -1.0 | ++-----------+---------------------------+ +| *Setter* | set_default_margin(value) | ++-----------+---------------------------+ +| *Getter* | get_default_margin() | ++-----------+---------------------------+ The top margin for the contents of this style box. Increasing this value reduces the space available to the contents from the top. diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index e734027d8..299ade2a6 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -19,51 +19,51 @@ Customizable Stylebox with a given set of parameters. (no texture required) Properties ---------- -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`anti_aliasing` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`anti_aliasing_size` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`bg_color` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`border_blend` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`border_color` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_bottom` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_left` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_right` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_top` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_detail` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_bottom_left` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_bottom_right` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_top_left` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_top_right` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_center` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_bottom` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_left` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_right` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_top` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`shadow_color` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`shadow_offset` | -+-------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_size` | -+-------------------------------+-------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`anti_aliasing` | true | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`anti_aliasing_size` | 1 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`Color` | :ref:`bg_color` | Color( 0.6, 0.6, 0.6, 1 ) | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`border_blend` | false | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`Color` | :ref:`border_color` | Color( 0.8, 0.8, 0.8, 1 ) | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`border_width_bottom` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`border_width_left` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`border_width_right` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`border_width_top` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`corner_detail` | 8 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`corner_radius_bottom_left` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`corner_radius_bottom_right` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`corner_radius_top_left` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`corner_radius_top_right` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`draw_center` | true | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`expand_margin_bottom` | 0.0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`expand_margin_left` | 0.0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`expand_margin_right` | 0.0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`float` | :ref:`expand_margin_top` | 0.0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`Color` | :ref:`shadow_color` | Color( 0, 0, 0, 0.6 ) | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`Vector2` | :ref:`shadow_offset` | Vector2( 0, 0 ) | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`shadow_size` | 0 | ++-------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ Methods ------- @@ -117,11 +117,13 @@ Property Descriptions - :ref:`bool` **anti_aliasing** -+----------+-------------------------+ -| *Setter* | set_anti_aliased(value) | -+----------+-------------------------+ -| *Getter* | is_anti_aliased() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | true | ++-----------+-------------------------+ +| *Setter* | set_anti_aliased(value) | ++-----------+-------------------------+ +| *Getter* | is_anti_aliased() | ++-----------+-------------------------+ Antialiasing draws a small ring around the edges, which fades to transparency. As a result, edges look much smoother. This is only noticeable when using rounded corners. @@ -129,11 +131,13 @@ Antialiasing draws a small ring around the edges, which fades to transparency. A - :ref:`int` **anti_aliasing_size** -+----------+--------------------+ -| *Setter* | set_aa_size(value) | -+----------+--------------------+ -| *Getter* | get_aa_size() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1 | ++-----------+--------------------+ +| *Setter* | set_aa_size(value) | ++-----------+--------------------+ +| *Getter* | get_aa_size() | ++-----------+--------------------+ This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. @@ -141,11 +145,13 @@ This changes the size of the faded ring. Higher values can be used to achieve a - :ref:`Color` **bg_color** -+----------+---------------------+ -| *Setter* | set_bg_color(value) | -+----------+---------------------+ -| *Getter* | get_bg_color() | -+----------+---------------------+ ++-----------+---------------------------+ +| *Default* | Color( 0.6, 0.6, 0.6, 1 ) | ++-----------+---------------------------+ +| *Setter* | set_bg_color(value) | ++-----------+---------------------------+ +| *Getter* | get_bg_color() | ++-----------+---------------------------+ The background color of the stylebox. @@ -153,11 +159,13 @@ The background color of the stylebox. - :ref:`bool` **border_blend** -+----------+-------------------------+ -| *Setter* | set_border_blend(value) | -+----------+-------------------------+ -| *Getter* | get_border_blend() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_border_blend(value) | ++-----------+-------------------------+ +| *Getter* | get_border_blend() | ++-----------+-------------------------+ If ``true``, the border will fade into the background color. @@ -165,11 +173,13 @@ If ``true``, the border will fade into the background color. - :ref:`Color` **border_color** -+----------+-------------------------+ -| *Setter* | set_border_color(value) | -+----------+-------------------------+ -| *Getter* | get_border_color() | -+----------+-------------------------+ ++-----------+---------------------------+ +| *Default* | Color( 0.8, 0.8, 0.8, 1 ) | ++-----------+---------------------------+ +| *Setter* | set_border_color(value) | ++-----------+---------------------------+ +| *Getter* | get_border_color() | ++-----------+---------------------------+ Sets the color of the border. @@ -177,11 +187,13 @@ Sets the color of the border. - :ref:`int` **border_width_bottom** -+----------+-------------------------+ -| *Setter* | set_border_width(value) | -+----------+-------------------------+ -| *Getter* | get_border_width() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_border_width(value) | ++-----------+-------------------------+ +| *Getter* | get_border_width() | ++-----------+-------------------------+ Border width for the bottom border. @@ -189,11 +201,13 @@ Border width for the bottom border. - :ref:`int` **border_width_left** -+----------+-------------------------+ -| *Setter* | set_border_width(value) | -+----------+-------------------------+ -| *Getter* | get_border_width() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_border_width(value) | ++-----------+-------------------------+ +| *Getter* | get_border_width() | ++-----------+-------------------------+ Border width for the left border. @@ -201,11 +215,13 @@ Border width for the left border. - :ref:`int` **border_width_right** -+----------+-------------------------+ -| *Setter* | set_border_width(value) | -+----------+-------------------------+ -| *Getter* | get_border_width() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_border_width(value) | ++-----------+-------------------------+ +| *Getter* | get_border_width() | ++-----------+-------------------------+ Border width for the right border. @@ -213,11 +229,13 @@ Border width for the right border. - :ref:`int` **border_width_top** -+----------+-------------------------+ -| *Setter* | set_border_width(value) | -+----------+-------------------------+ -| *Getter* | get_border_width() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_border_width(value) | ++-----------+-------------------------+ +| *Getter* | get_border_width() | ++-----------+-------------------------+ Border width for the top border. @@ -225,11 +243,13 @@ Border width for the top border. - :ref:`int` **corner_detail** -+----------+--------------------------+ -| *Setter* | set_corner_detail(value) | -+----------+--------------------------+ -| *Getter* | get_corner_detail() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 8 | ++-----------+--------------------------+ +| *Setter* | set_corner_detail(value) | ++-----------+--------------------------+ +| *Getter* | get_corner_detail() | ++-----------+--------------------------+ This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius (:ref:`set_corner_radius_all`) into account. @@ -239,11 +259,13 @@ For corner radii smaller than 10, 4-5 should be enough. For corner radii smaller - :ref:`int` **corner_radius_bottom_left** -+----------+--------------------------+ -| *Setter* | set_corner_radius(value) | -+----------+--------------------------+ -| *Getter* | get_corner_radius() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_corner_radius(value) | ++-----------+--------------------------+ +| *Getter* | get_corner_radius() | ++-----------+--------------------------+ The bottom-left corner's radius. If ``0``, the corner is not rounded. @@ -251,11 +273,13 @@ The bottom-left corner's radius. If ``0``, the corner is not rounded. - :ref:`int` **corner_radius_bottom_right** -+----------+--------------------------+ -| *Setter* | set_corner_radius(value) | -+----------+--------------------------+ -| *Getter* | get_corner_radius() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_corner_radius(value) | ++-----------+--------------------------+ +| *Getter* | get_corner_radius() | ++-----------+--------------------------+ The bottom-right corner's radius. If ``0``, the corner is not rounded. @@ -263,11 +287,13 @@ The bottom-right corner's radius. If ``0``, the corner is not rounded. - :ref:`int` **corner_radius_top_left** -+----------+--------------------------+ -| *Setter* | set_corner_radius(value) | -+----------+--------------------------+ -| *Getter* | get_corner_radius() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_corner_radius(value) | ++-----------+--------------------------+ +| *Getter* | get_corner_radius() | ++-----------+--------------------------+ The top-left corner's radius. If ``0``, the corner is not rounded. @@ -275,11 +301,13 @@ The top-left corner's radius. If ``0``, the corner is not rounded. - :ref:`int` **corner_radius_top_right** -+----------+--------------------------+ -| *Setter* | set_corner_radius(value) | -+----------+--------------------------+ -| *Getter* | get_corner_radius() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_corner_radius(value) | ++-----------+--------------------------+ +| *Getter* | get_corner_radius() | ++-----------+--------------------------+ The top-right corner's radius. If ``0``, the corner is not rounded. @@ -287,11 +315,13 @@ The top-right corner's radius. If ``0``, the corner is not rounded. - :ref:`bool` **draw_center** -+----------+--------------------------+ -| *Setter* | set_draw_center(value) | -+----------+--------------------------+ -| *Getter* | is_draw_center_enabled() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | true | ++-----------+--------------------------+ +| *Setter* | set_draw_center(value) | ++-----------+--------------------------+ +| *Getter* | is_draw_center_enabled() | ++-----------+--------------------------+ Toggles drawing of the inner part of the stylebox. @@ -299,11 +329,13 @@ Toggles drawing of the inner part of the stylebox. - :ref:`float` **expand_margin_bottom** -+----------+--------------------------+ -| *Setter* | set_expand_margin(value) | -+----------+--------------------------+ -| *Getter* | get_expand_margin() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------+ +| *Setter* | set_expand_margin(value) | ++-----------+--------------------------+ +| *Getter* | get_expand_margin() | ++-----------+--------------------------+ Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with :ref:`border_width_bottom` to draw a border outside the control rect. @@ -311,11 +343,13 @@ Expands the stylebox outside of the control rect on the bottom edge. Useful in c - :ref:`float` **expand_margin_left** -+----------+--------------------------+ -| *Setter* | set_expand_margin(value) | -+----------+--------------------------+ -| *Getter* | get_expand_margin() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------+ +| *Setter* | set_expand_margin(value) | ++-----------+--------------------------+ +| *Getter* | get_expand_margin() | ++-----------+--------------------------+ Expands the stylebox outside of the control rect on the left edge. Useful in combination with :ref:`border_width_left` to draw a border outside the control rect. @@ -323,11 +357,13 @@ Expands the stylebox outside of the control rect on the left edge. Useful in com - :ref:`float` **expand_margin_right** -+----------+--------------------------+ -| *Setter* | set_expand_margin(value) | -+----------+--------------------------+ -| *Getter* | get_expand_margin() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------+ +| *Setter* | set_expand_margin(value) | ++-----------+--------------------------+ +| *Getter* | get_expand_margin() | ++-----------+--------------------------+ Expands the stylebox outside of the control rect on the right edge. Useful in combination with :ref:`border_width_right` to draw a border outside the control rect. @@ -335,11 +371,13 @@ Expands the stylebox outside of the control rect on the right edge. Useful in co - :ref:`float` **expand_margin_top** -+----------+--------------------------+ -| *Setter* | set_expand_margin(value) | -+----------+--------------------------+ -| *Getter* | get_expand_margin() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0.0 | ++-----------+--------------------------+ +| *Setter* | set_expand_margin(value) | ++-----------+--------------------------+ +| *Getter* | get_expand_margin() | ++-----------+--------------------------+ Expands the stylebox outside of the control rect on the top edge. Useful in combination with :ref:`border_width_top` to draw a border outside the control rect. @@ -347,11 +385,13 @@ Expands the stylebox outside of the control rect on the top edge. Useful in comb - :ref:`Color` **shadow_color** -+----------+-------------------------+ -| *Setter* | set_shadow_color(value) | -+----------+-------------------------+ -| *Getter* | get_shadow_color() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | Color( 0, 0, 0, 0.6 ) | ++-----------+-------------------------+ +| *Setter* | set_shadow_color(value) | ++-----------+-------------------------+ +| *Getter* | get_shadow_color() | ++-----------+-------------------------+ The color of the shadow. This has no effect if :ref:`shadow_size` is lower than 1. @@ -359,11 +399,13 @@ The color of the shadow. This has no effect if :ref:`shadow_size` **shadow_offset** -+----------+--------------------------+ -| *Setter* | set_shadow_offset(value) | -+----------+--------------------------+ -| *Getter* | get_shadow_offset() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+--------------------------+ +| *Setter* | set_shadow_offset(value) | ++-----------+--------------------------+ +| *Getter* | get_shadow_offset() | ++-----------+--------------------------+ The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox. @@ -371,11 +413,13 @@ The shadow offset in pixels. Adjusts the position of the shadow relatively to th - :ref:`int` **shadow_size** -+----------+------------------------+ -| *Setter* | set_shadow_size(value) | -+----------+------------------------+ -| *Getter* | get_shadow_size() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_shadow_size(value) | ++-----------+------------------------+ +| *Getter* | get_shadow_size() | ++-----------+------------------------+ The shadow size in pixels. diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 9f8509b77..f12b08865 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -19,17 +19,17 @@ Brief Description Properties ---------- -+---------------------------+-----------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`grow_begin` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`grow_end` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`thickness` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`vertical` | -+---------------------------+-----------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`color` | Color( 0, 0, 0, 1 ) | ++---------------------------+-----------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`grow_begin` | 1.0 | ++---------------------------+-----------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`grow_end` | 1.0 | ++---------------------------+-----------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`thickness` | 1 | ++---------------------------+-----------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`vertical` | false | ++---------------------------+-----------------------------------------------------------+---------------------+ Property Descriptions --------------------- @@ -38,49 +38,59 @@ Property Descriptions - :ref:`Color` **color** -+----------+------------------+ -| *Setter* | set_color(value) | -+----------+------------------+ -| *Getter* | get_color() | -+----------+------------------+ ++-----------+---------------------+ +| *Default* | Color( 0, 0, 0, 1 ) | ++-----------+---------------------+ +| *Setter* | set_color(value) | ++-----------+---------------------+ +| *Getter* | get_color() | ++-----------+---------------------+ .. _class_StyleBoxLine_property_grow_begin: - :ref:`float` **grow_begin** -+----------+-----------------------+ -| *Setter* | set_grow_begin(value) | -+----------+-----------------------+ -| *Getter* | get_grow_begin() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1.0 | ++-----------+-----------------------+ +| *Setter* | set_grow_begin(value) | ++-----------+-----------------------+ +| *Getter* | get_grow_begin() | ++-----------+-----------------------+ .. _class_StyleBoxLine_property_grow_end: - :ref:`float` **grow_end** -+----------+---------------------+ -| *Setter* | set_grow_end(value) | -+----------+---------------------+ -| *Getter* | get_grow_end() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 1.0 | ++-----------+---------------------+ +| *Setter* | set_grow_end(value) | ++-----------+---------------------+ +| *Getter* | get_grow_end() | ++-----------+---------------------+ .. _class_StyleBoxLine_property_thickness: - :ref:`int` **thickness** -+----------+----------------------+ -| *Setter* | set_thickness(value) | -+----------+----------------------+ -| *Getter* | get_thickness() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1 | ++-----------+----------------------+ +| *Setter* | set_thickness(value) | ++-----------+----------------------+ +| *Getter* | get_thickness() | ++-----------+----------------------+ .. _class_StyleBoxLine_property_vertical: - :ref:`bool` **vertical** -+----------+---------------------+ -| *Setter* | set_vertical(value) | -+----------+---------------------+ -| *Getter* | is_vertical() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_vertical(value) | ++-----------+---------------------+ +| *Getter* | is_vertical() | ++-----------+---------------------+ diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 35764696e..f39a69cc4 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -19,37 +19,37 @@ Texture-based nine-patch :ref:`StyleBox`. Properties ---------- -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_center` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_bottom` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_left` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_right` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_top` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_bottom` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_left` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_right` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_top` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`modulate_color` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | 0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | 0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`draw_center` | true | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`expand_margin_bottom` | 0.0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`expand_margin_left` | 0.0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`expand_margin_right` | 0.0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`expand_margin_top` | 0.0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`margin_bottom` | 0.0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`margin_left` | 0.0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`margin_right` | 0.0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`margin_top` | 0.0 | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`modulate_color` | Color( 1, 1, 1, 1 ) | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`normal_map` | null | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`Rect2` | :ref:`region_rect` | Rect2( 0, 0, 0, 0 ) | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture` | null | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ Methods ------- @@ -98,41 +98,49 @@ Property Descriptions - :ref:`AxisStretchMode` **axis_stretch_horizontal** -+----------+--------------------------------+ -| *Setter* | set_h_axis_stretch_mode(value) | -+----------+--------------------------------+ -| *Getter* | get_h_axis_stretch_mode() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0 | ++-----------+--------------------------------+ +| *Setter* | set_h_axis_stretch_mode(value) | ++-----------+--------------------------------+ +| *Getter* | get_h_axis_stretch_mode() | ++-----------+--------------------------------+ .. _class_StyleBoxTexture_property_axis_stretch_vertical: - :ref:`AxisStretchMode` **axis_stretch_vertical** -+----------+--------------------------------+ -| *Setter* | set_v_axis_stretch_mode(value) | -+----------+--------------------------------+ -| *Getter* | get_v_axis_stretch_mode() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0 | ++-----------+--------------------------------+ +| *Setter* | set_v_axis_stretch_mode(value) | ++-----------+--------------------------------+ +| *Getter* | get_v_axis_stretch_mode() | ++-----------+--------------------------------+ .. _class_StyleBoxTexture_property_draw_center: - :ref:`bool` **draw_center** -+----------+--------------------------+ -| *Setter* | set_draw_center(value) | -+----------+--------------------------+ -| *Getter* | is_draw_center_enabled() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | true | ++-----------+--------------------------+ +| *Setter* | set_draw_center(value) | ++-----------+--------------------------+ +| *Getter* | is_draw_center_enabled() | ++-----------+--------------------------+ .. _class_StyleBoxTexture_property_expand_margin_bottom: - :ref:`float` **expand_margin_bottom** -+----------+-------------------------------+ -| *Setter* | set_expand_margin_size(value) | -+----------+-------------------------------+ -| *Getter* | get_expand_margin_size() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------+ +| *Setter* | set_expand_margin_size(value) | ++-----------+-------------------------------+ +| *Getter* | get_expand_margin_size() | ++-----------+-------------------------------+ Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested. @@ -140,11 +148,13 @@ Expands the bottom margin of this style box when drawing, causing it to be drawn - :ref:`float` **expand_margin_left** -+----------+-------------------------------+ -| *Setter* | set_expand_margin_size(value) | -+----------+-------------------------------+ -| *Getter* | get_expand_margin_size() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------+ +| *Setter* | set_expand_margin_size(value) | ++-----------+-------------------------------+ +| *Getter* | get_expand_margin_size() | ++-----------+-------------------------------+ Expands the left margin of this style box when drawing, causing it to be drawn larger than requested. @@ -152,11 +162,13 @@ Expands the left margin of this style box when drawing, causing it to be drawn l - :ref:`float` **expand_margin_right** -+----------+-------------------------------+ -| *Setter* | set_expand_margin_size(value) | -+----------+-------------------------------+ -| *Getter* | get_expand_margin_size() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------+ +| *Setter* | set_expand_margin_size(value) | ++-----------+-------------------------------+ +| *Getter* | get_expand_margin_size() | ++-----------+-------------------------------+ Expands the right margin of this style box when drawing, causing it to be drawn larger than requested. @@ -164,11 +176,13 @@ Expands the right margin of this style box when drawing, causing it to be drawn - :ref:`float` **expand_margin_top** -+----------+-------------------------------+ -| *Setter* | set_expand_margin_size(value) | -+----------+-------------------------------+ -| *Getter* | get_expand_margin_size() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------------+ +| *Setter* | set_expand_margin_size(value) | ++-----------+-------------------------------+ +| *Getter* | get_expand_margin_size() | ++-----------+-------------------------------+ Expands the top margin of this style box when drawing, causing it to be drawn larger than requested. @@ -176,11 +190,13 @@ Expands the top margin of this style box when drawing, causing it to be drawn la - :ref:`float` **margin_bottom** -+----------+------------------------+ -| *Setter* | set_margin_size(value) | -+----------+------------------------+ -| *Getter* | get_margin_size() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_margin_size(value) | ++-----------+------------------------+ +| *Getter* | get_margin_size() | ++-----------+------------------------+ Increases the bottom margin of the 3×3 texture box. @@ -192,11 +208,13 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_bottom - :ref:`float` **margin_left** -+----------+------------------------+ -| *Setter* | set_margin_size(value) | -+----------+------------------------+ -| *Getter* | get_margin_size() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_margin_size(value) | ++-----------+------------------------+ +| *Getter* | get_margin_size() | ++-----------+------------------------+ Increases the left margin of the 3×3 texture box. @@ -208,11 +226,13 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_left` **margin_right** -+----------+------------------------+ -| *Setter* | set_margin_size(value) | -+----------+------------------------+ -| *Getter* | get_margin_size() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_margin_size(value) | ++-----------+------------------------+ +| *Getter* | get_margin_size() | ++-----------+------------------------+ Increases the right margin of the 3×3 texture box. @@ -224,11 +244,13 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_right< - :ref:`float` **margin_top** -+----------+------------------------+ -| *Setter* | set_margin_size(value) | -+----------+------------------------+ -| *Getter* | get_margin_size() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0.0 | ++-----------+------------------------+ +| *Setter* | set_margin_size(value) | ++-----------+------------------------+ +| *Getter* | get_margin_size() | ++-----------+------------------------+ Increases the top margin of the 3×3 texture box. @@ -240,11 +262,13 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_top` **modulate_color** -+----------+---------------------+ -| *Setter* | set_modulate(value) | -+----------+---------------------+ -| *Getter* | get_modulate() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_modulate(value) | ++-----------+---------------------+ +| *Getter* | get_modulate() | ++-----------+---------------------+ Modulates the color of the texture when this style box is drawn. @@ -252,11 +276,13 @@ Modulates the color of the texture when this style box is drawn. - :ref:`Texture` **normal_map** -+----------+-----------------------+ -| *Setter* | set_normal_map(value) | -+----------+-----------------------+ -| *Getter* | get_normal_map() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++-----------+-----------------------+ +| *Getter* | get_normal_map() | ++-----------+-----------------------+ The normal map to use when drawing this style box. @@ -264,11 +290,13 @@ The normal map to use when drawing this style box. - :ref:`Rect2` **region_rect** -+----------+------------------------+ -| *Setter* | set_region_rect(value) | -+----------+------------------------+ -| *Getter* | get_region_rect() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | Rect2( 0, 0, 0, 0 ) | ++-----------+------------------------+ +| *Setter* | set_region_rect(value) | ++-----------+------------------------+ +| *Getter* | get_region_rect() | ++-----------+------------------------+ Species a sub region of the texture to use. @@ -278,11 +306,13 @@ This is equivalent to first wrapping the texture in an :ref:`AtlasTexture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ The texture to use when drawing this style box. diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index ff64a09c0..f76e49676 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -19,15 +19,15 @@ Tabbed container. Properties ---------- -+---------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`current_tab` | -+---------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | -+---------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`TabAlign` | :ref:`tab_align` | -+---------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tabs_visible` | -+---------------------------------------------+-----------------------------------------------------------------------------------------+ ++---------------------------------------------+-----------------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`current_tab` | 0 | ++---------------------------------------------+-----------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | false | ++---------------------------------------------+-----------------------------------------------------------------------------------------+-------+ +| :ref:`TabAlign` | :ref:`tab_align` | 1 | ++---------------------------------------------+-----------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`tabs_visible` | true | ++---------------------------------------------+-----------------------------------------------------------------------------------------+-------+ Methods ------- @@ -65,45 +65,45 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`Texture` | decrement | -+---------------------------------+---------------------+ -| :ref:`Texture` | decrement_highlight | -+---------------------------------+---------------------+ -| :ref:`Font` | font | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_bg | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_fg | -+---------------------------------+---------------------+ -| :ref:`int` | hseparation | -+---------------------------------+---------------------+ -| :ref:`Texture` | increment | -+---------------------------------+---------------------+ -| :ref:`Texture` | increment_highlight | -+---------------------------------+---------------------+ -| :ref:`int` | label_valign_bg | -+---------------------------------+---------------------+ -| :ref:`int` | label_valign_fg | -+---------------------------------+---------------------+ -| :ref:`Texture` | menu | -+---------------------------------+---------------------+ -| :ref:`Texture` | menu_highlight | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | panel | -+---------------------------------+---------------------+ -| :ref:`int` | side_margin | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | tab_bg | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | tab_disabled | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | tab_fg | -+---------------------------------+---------------------+ -| :ref:`int` | top_margin | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | decrement | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | decrement_highlight | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_bg | Color( 0.690196, 0.690196, 0.690196, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_fg | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | hseparation | 4 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | increment | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | increment_highlight | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | label_valign_bg | 2 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | label_valign_fg | 0 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | menu | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | menu_highlight | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | panel | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | side_margin | 8 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | tab_bg | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | tab_disabled | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | tab_fg | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | top_margin | 24 | ++---------------------------------+---------------------+------------------------------------------+ Signals ------- @@ -163,11 +163,13 @@ Property Descriptions - :ref:`int` **current_tab** -+----------+------------------------+ -| *Setter* | set_current_tab(value) | -+----------+------------------------+ -| *Getter* | get_current_tab() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_current_tab(value) | ++-----------+------------------------+ +| *Getter* | get_current_tab() | ++-----------+------------------------+ The current tab index. When set, this index's :ref:`Control` node's ``visible`` property is set to ``true`` and all others are set to ``false``. @@ -175,11 +177,13 @@ The current tab index. When set, this index's :ref:`Control` node - :ref:`bool` **drag_to_rearrange_enabled** -+----------+--------------------------------------+ -| *Setter* | set_drag_to_rearrange_enabled(value) | -+----------+--------------------------------------+ -| *Getter* | get_drag_to_rearrange_enabled() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | false | ++-----------+--------------------------------------+ +| *Setter* | set_drag_to_rearrange_enabled(value) | ++-----------+--------------------------------------+ +| *Getter* | get_drag_to_rearrange_enabled() | ++-----------+--------------------------------------+ If ``true``, tabs can be rearranged with mouse drag. @@ -187,11 +191,13 @@ If ``true``, tabs can be rearranged with mouse drag. - :ref:`TabAlign` **tab_align** -+----------+----------------------+ -| *Setter* | set_tab_align(value) | -+----------+----------------------+ -| *Getter* | get_tab_align() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1 | ++-----------+----------------------+ +| *Setter* | set_tab_align(value) | ++-----------+----------------------+ +| *Getter* | get_tab_align() | ++-----------+----------------------+ The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. @@ -199,13 +205,15 @@ The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants fo - :ref:`bool` **tabs_visible** -+----------+-------------------------+ -| *Setter* | set_tabs_visible(value) | -+----------+-------------------------+ -| *Getter* | are_tabs_visible() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | true | ++-----------+-------------------------+ +| *Setter* | set_tabs_visible(value) | ++-----------+-------------------------+ +| *Getter* | are_tabs_visible() | ++-----------+-------------------------+ -If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden. Default value: ``true``. +If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden. Method Descriptions ------------------- diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 2d2c97f77..95bc366a8 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -19,17 +19,17 @@ Tabs control. Properties ---------- -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`current_tab` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scrolling_enabled` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`TabAlign` | :ref:`tab_align` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`CloseButtonDisplayPolicy` | :ref:`tab_close_display_policy` | -+---------------------------------------------------------------------+---------------------------------------------------------------------------------+ ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`current_tab` | 0 | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | false | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`scrolling_enabled` | true | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------+ +| :ref:`TabAlign` | :ref:`tab_align` | 1 | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------+ +| :ref:`CloseButtonDisplayPolicy` | :ref:`tab_close_display_policy` | 0 | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+-------+ Methods ------- @@ -75,45 +75,45 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`StyleBox` | button | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | button_pressed | -+---------------------------------+---------------------+ -| :ref:`Texture` | close | -+---------------------------------+---------------------+ -| :ref:`Texture` | decrement | -+---------------------------------+---------------------+ -| :ref:`Texture` | decrement_highlight | -+---------------------------------+---------------------+ -| :ref:`Font` | font | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_bg | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_fg | -+---------------------------------+---------------------+ -| :ref:`int` | hseparation | -+---------------------------------+---------------------+ -| :ref:`Texture` | increment | -+---------------------------------+---------------------+ -| :ref:`Texture` | increment_highlight | -+---------------------------------+---------------------+ -| :ref:`int` | label_valign_bg | -+---------------------------------+---------------------+ -| :ref:`int` | label_valign_fg | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | panel | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | tab_bg | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | tab_disabled | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | tab_fg | -+---------------------------------+---------------------+ -| :ref:`int` | top_margin | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | button | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | button_pressed | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | close | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | decrement | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | decrement_highlight | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_bg | Color( 0.690196, 0.690196, 0.690196, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_fg | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | hseparation | 4 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | increment | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Texture` | increment_highlight | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | label_valign_bg | 2 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | label_valign_fg | 0 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | panel | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | tab_bg | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | tab_disabled | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | tab_fg | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | top_margin | 24 | ++---------------------------------+---------------------+------------------------------------------+ Signals ------- @@ -197,11 +197,13 @@ Property Descriptions - :ref:`int` **current_tab** -+----------+------------------------+ -| *Setter* | set_current_tab(value) | -+----------+------------------------+ -| *Getter* | get_current_tab() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_current_tab(value) | ++-----------+------------------------+ +| *Getter* | get_current_tab() | ++-----------+------------------------+ Select tab at index ``tab_idx``. @@ -209,11 +211,13 @@ Select tab at index ``tab_idx``. - :ref:`bool` **drag_to_rearrange_enabled** -+----------+--------------------------------------+ -| *Setter* | set_drag_to_rearrange_enabled(value) | -+----------+--------------------------------------+ -| *Getter* | get_drag_to_rearrange_enabled() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | false | ++-----------+--------------------------------------+ +| *Setter* | set_drag_to_rearrange_enabled(value) | ++-----------+--------------------------------------+ +| *Getter* | get_drag_to_rearrange_enabled() | ++-----------+--------------------------------------+ If ``true``, tabs can be rearranged with mouse drag. @@ -221,21 +225,25 @@ If ``true``, tabs can be rearranged with mouse drag. - :ref:`bool` **scrolling_enabled** -+----------+------------------------------+ -| *Setter* | set_scrolling_enabled(value) | -+----------+------------------------------+ -| *Getter* | get_scrolling_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | true | ++-----------+------------------------------+ +| *Setter* | set_scrolling_enabled(value) | ++-----------+------------------------------+ +| *Getter* | get_scrolling_enabled() | ++-----------+------------------------------+ .. _class_Tabs_property_tab_align: - :ref:`TabAlign` **tab_align** -+----------+----------------------+ -| *Setter* | set_tab_align(value) | -+----------+----------------------+ -| *Getter* | get_tab_align() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1 | ++-----------+----------------------+ +| *Setter* | set_tab_align(value) | ++-----------+----------------------+ +| *Getter* | get_tab_align() | ++-----------+----------------------+ The alignment of all tabs. See enum ``TabAlign`` constants for details. @@ -243,11 +251,13 @@ The alignment of all tabs. See enum ``TabAlign`` constants for details. - :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** -+----------+-------------------------------------+ -| *Setter* | set_tab_close_display_policy(value) | -+----------+-------------------------------------+ -| *Getter* | get_tab_close_display_policy() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | 0 | ++-----------+-------------------------------------+ +| *Setter* | set_tab_close_display_policy(value) | ++-----------+-------------------------------------+ +| *Getter* | get_tab_close_display_policy() | ++-----------+-------------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 325c5411e..318360262 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -19,47 +19,47 @@ Multiline text editing control. Properties ---------- -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`breakpoint_gutter` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`caret_blink` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`caret_blink_speed` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`caret_block_mode` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`caret_moving_by_right_click` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`context_menu_enabled` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_spaces` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_tabs` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fold_gutter` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hiding_enabled` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`highlight_all_occurrences` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`highlight_current_line` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`override_selected_font_color` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`readonly` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_line_numbers` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_scrolling` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`syntax_highlighting` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`v_scroll_speed` | -+-----------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`wrap_enabled` | -+-----------------------------+-------------------------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`breakpoint_gutter` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`caret_blink` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`caret_blink_speed` | 0.65 | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`caret_block_mode` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`caret_moving_by_right_click` | true | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`context_menu_enabled` | true | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`draw_spaces` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`draw_tabs` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`fold_gutter` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`hiding_enabled` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`highlight_all_occurrences` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`highlight_current_line` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`override_selected_font_color` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`readonly` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`show_line_numbers` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`smooth_scrolling` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`syntax_highlighting` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`text` | "" | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`v_scroll_speed` | 80.0 | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`wrap_enabled` | false | ++-----------------------------+-------------------------------------------------------------------------------------------+-------+ Methods ------- @@ -155,85 +155,85 @@ Methods Theme Properties ---------------- -+---------------------------------+-----------------------------+ -| :ref:`Color` | background_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | bookmark_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | brace_mismatch_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | breakpoint_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | caret_background_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | caret_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | code_folding_color | -+---------------------------------+-----------------------------+ -| :ref:`StyleBox` | completion | -+---------------------------------+-----------------------------+ -| :ref:`Color` | completion_background_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | completion_existing_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | completion_font_color | -+---------------------------------+-----------------------------+ -| :ref:`int` | completion_lines | -+---------------------------------+-----------------------------+ -| :ref:`int` | completion_max_width | -+---------------------------------+-----------------------------+ -| :ref:`Color` | completion_scroll_color | -+---------------------------------+-----------------------------+ -| :ref:`int` | completion_scroll_width | -+---------------------------------+-----------------------------+ -| :ref:`Color` | completion_selected_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | current_line_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | executing_line_color | -+---------------------------------+-----------------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+-----------------------------+ -| :ref:`Texture` | fold | -+---------------------------------+-----------------------------+ -| :ref:`Texture` | folded | -+---------------------------------+-----------------------------+ -| :ref:`Font` | font | -+---------------------------------+-----------------------------+ -| :ref:`Color` | font_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | font_color_readonly | -+---------------------------------+-----------------------------+ -| :ref:`Color` | font_color_selected | -+---------------------------------+-----------------------------+ -| :ref:`Color` | function_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | line_number_color | -+---------------------------------+-----------------------------+ -| :ref:`int` | line_spacing | -+---------------------------------+-----------------------------+ -| :ref:`Color` | mark_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | member_variable_color | -+---------------------------------+-----------------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+-----------------------------+ -| :ref:`Color` | number_color | -+---------------------------------+-----------------------------+ -| :ref:`StyleBox` | read_only | -+---------------------------------+-----------------------------+ -| :ref:`Color` | safe_line_number_color | -+---------------------------------+-----------------------------+ -| :ref:`Color` | selection_color | -+---------------------------------+-----------------------------+ -| :ref:`Texture` | space | -+---------------------------------+-----------------------------+ -| :ref:`Color` | symbol_color | -+---------------------------------+-----------------------------+ -| :ref:`Texture` | tab | -+---------------------------------+-----------------------------+ -| :ref:`Color` | word_highlighted_color | -+---------------------------------+-----------------------------+ ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | background_color | Color( 0, 0, 0, 0 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | bookmark_color | Color( 0.08, 0.49, 0.98, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | brace_mismatch_color | Color( 1, 0.2, 0.2, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | breakpoint_color | Color( 0.8, 0.8, 0.4, 0.2 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | caret_background_color | Color( 0, 0, 0, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | caret_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | code_folding_color | Color( 0.8, 0.8, 0.8, 0.8 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`StyleBox` | completion | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | completion_background_color | Color( 0.172549, 0.164706, 0.196078, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | completion_existing_color | Color( 0.87451, 0.87451, 0.87451, 0.129412 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | completion_font_color | Color( 0.666667, 0.666667, 0.666667, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`int` | completion_lines | 7 | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`int` | completion_max_width | 50 | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | completion_scroll_color | Color( 1, 1, 1, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`int` | completion_scroll_width | 3 | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | completion_selected_color | Color( 0.262745, 0.258824, 0.266667, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | current_line_color | Color( 0.25, 0.25, 0.26, 0.8 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | executing_line_color | Color( 0.2, 0.8, 0.2, 0.4 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Texture` | fold | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Texture` | folded | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | font_color_readonly | Color( 0.878431, 0.878431, 0.878431, 0.5 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | font_color_selected | Color( 0, 0, 0, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | function_color | Color( 0.4, 0.635294, 0.807843, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | line_number_color | Color( 0.666667, 0.666667, 0.666667, 0.4 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`int` | line_spacing | 4 | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | mark_color | Color( 1, 0.4, 0.4, 0.4 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | member_variable_color | Color( 0.901961, 0.305882, 0.34902, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | number_color | Color( 0.921569, 0.584314, 0.196078, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`StyleBox` | read_only | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | safe_line_number_color | Color( 0.666667, 0.784314, 0.666667, 0.6 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | selection_color | Color( 0.490196, 0.490196, 0.490196, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Texture` | space | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | symbol_color | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Texture` | tab | | ++---------------------------------+-----------------------------+----------------------------------------------+ +| :ref:`Color` | word_highlighted_color | Color( 0.8, 0.9, 0.9, 0.15 ) | ++---------------------------------+-----------------------------+----------------------------------------------+ Signals ------- @@ -337,11 +337,13 @@ Property Descriptions - :ref:`bool` **breakpoint_gutter** -+----------+--------------------------------------+ -| *Setter* | set_breakpoint_gutter_enabled(value) | -+----------+--------------------------------------+ -| *Getter* | is_breakpoint_gutter_enabled() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | false | ++-----------+--------------------------------------+ +| *Setter* | set_breakpoint_gutter_enabled(value) | ++-----------+--------------------------------------+ +| *Getter* | is_breakpoint_gutter_enabled() | ++-----------+--------------------------------------+ If ``true``, the breakpoint gutter is visible. @@ -349,11 +351,13 @@ If ``true``, the breakpoint gutter is visible. - :ref:`bool` **caret_blink** -+----------+---------------------------------+ -| *Setter* | cursor_set_blink_enabled(value) | -+----------+---------------------------------+ -| *Getter* | cursor_get_blink_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | cursor_set_blink_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | cursor_get_blink_enabled() | ++-----------+---------------------------------+ If ``true``, the caret (visual cursor) blinks. @@ -361,11 +365,13 @@ If ``true``, the caret (visual cursor) blinks. - :ref:`float` **caret_blink_speed** -+----------+-------------------------------+ -| *Setter* | cursor_set_blink_speed(value) | -+----------+-------------------------------+ -| *Getter* | cursor_get_blink_speed() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.65 | ++-----------+-------------------------------+ +| *Setter* | cursor_set_blink_speed(value) | ++-----------+-------------------------------+ +| *Getter* | cursor_get_blink_speed() | ++-----------+-------------------------------+ Duration (in seconds) of a caret's blinking cycle. @@ -373,11 +379,13 @@ Duration (in seconds) of a caret's blinking cycle. - :ref:`bool` **caret_block_mode** -+----------+------------------------------+ -| *Setter* | cursor_set_block_mode(value) | -+----------+------------------------------+ -| *Getter* | cursor_is_block_mode() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | cursor_set_block_mode(value) | ++-----------+------------------------------+ +| *Getter* | cursor_is_block_mode() | ++-----------+------------------------------+ If ``true``, the caret displays as a rectangle. @@ -387,11 +395,13 @@ If ``false``, the caret displays as a bar. - :ref:`bool` **caret_moving_by_right_click** -+----------+------------------------------------+ -| *Setter* | set_right_click_moves_caret(value) | -+----------+------------------------------------+ -| *Getter* | is_right_click_moving_caret() | -+----------+------------------------------------+ ++-----------+------------------------------------+ +| *Default* | true | ++-----------+------------------------------------+ +| *Setter* | set_right_click_moves_caret(value) | ++-----------+------------------------------------+ +| *Getter* | is_right_click_moving_caret() | ++-----------+------------------------------------+ If ``true``, a right-click moves the cursor at the mouse position before displaying the context menu. @@ -401,11 +411,13 @@ If ``false``, the context menu disregards mouse location. - :ref:`bool` **context_menu_enabled** -+----------+---------------------------------+ -| *Setter* | set_context_menu_enabled(value) | -+----------+---------------------------------+ -| *Getter* | is_context_menu_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | true | ++-----------+---------------------------------+ +| *Setter* | set_context_menu_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | is_context_menu_enabled() | ++-----------+---------------------------------+ If ``true``, a right-click displays the context menu. @@ -413,11 +425,13 @@ If ``true``, a right-click displays the context menu. - :ref:`bool` **draw_spaces** -+----------+------------------------+ -| *Setter* | set_draw_spaces(value) | -+----------+------------------------+ -| *Getter* | is_drawing_spaces() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | false | ++-----------+------------------------+ +| *Setter* | set_draw_spaces(value) | ++-----------+------------------------+ +| *Getter* | is_drawing_spaces() | ++-----------+------------------------+ If ``true``, the "space" character will have a visible representation. @@ -425,11 +439,13 @@ If ``true``, the "space" character will have a visible representation. - :ref:`bool` **draw_tabs** -+----------+----------------------+ -| *Setter* | set_draw_tabs(value) | -+----------+----------------------+ -| *Getter* | is_drawing_tabs() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_draw_tabs(value) | ++-----------+----------------------+ +| *Getter* | is_drawing_tabs() | ++-----------+----------------------+ If ``true``, the "tab" character will have a visible representation. @@ -437,11 +453,13 @@ If ``true``, the "tab" character will have a visible representation. - :ref:`bool` **fold_gutter** -+----------+-----------------------------+ -| *Setter* | set_draw_fold_gutter(value) | -+----------+-----------------------------+ -| *Getter* | is_drawing_fold_gutter() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | false | ++-----------+-----------------------------+ +| *Setter* | set_draw_fold_gutter(value) | ++-----------+-----------------------------+ +| *Getter* | is_drawing_fold_gutter() | ++-----------+-----------------------------+ If ``true``, the fold gutter is visible. This enables folding groups of indented lines. @@ -449,11 +467,13 @@ If ``true``, the fold gutter is visible. This enables folding groups of indented - :ref:`bool` **hiding_enabled** -+----------+---------------------------+ -| *Setter* | set_hiding_enabled(value) | -+----------+---------------------------+ -| *Getter* | is_hiding_enabled() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_hiding_enabled(value) | ++-----------+---------------------------+ +| *Getter* | is_hiding_enabled() | ++-----------+---------------------------+ If ``true``, all lines that have been set to hidden by :ref:`set_line_as_hidden`, will not be visible. @@ -461,11 +481,13 @@ If ``true``, all lines that have been set to hidden by :ref:`set_line_as_hidden< - :ref:`bool` **highlight_all_occurrences** -+----------+----------------------------------------+ -| *Setter* | set_highlight_all_occurrences(value) | -+----------+----------------------------------------+ -| *Getter* | is_highlight_all_occurrences_enabled() | -+----------+----------------------------------------+ ++-----------+----------------------------------------+ +| *Default* | false | ++-----------+----------------------------------------+ +| *Setter* | set_highlight_all_occurrences(value) | ++-----------+----------------------------------------+ +| *Getter* | is_highlight_all_occurrences_enabled() | ++-----------+----------------------------------------+ If ``true``, all occurrences of the selected text will be highlighted. @@ -473,11 +495,13 @@ If ``true``, all occurrences of the selected text will be highlighted. - :ref:`bool` **highlight_current_line** -+----------+-------------------------------------+ -| *Setter* | set_highlight_current_line(value) | -+----------+-------------------------------------+ -| *Getter* | is_highlight_current_line_enabled() | -+----------+-------------------------------------+ ++-----------+-------------------------------------+ +| *Default* | false | ++-----------+-------------------------------------+ +| *Setter* | set_highlight_current_line(value) | ++-----------+-------------------------------------+ +| *Getter* | is_highlight_current_line_enabled() | ++-----------+-------------------------------------+ If ``true``, the line containing the cursor is highlighted. @@ -485,21 +509,25 @@ If ``true``, the line containing the cursor is highlighted. - :ref:`bool` **override_selected_font_color** -+----------+-----------------------------------------+ -| *Setter* | set_override_selected_font_color(value) | -+----------+-----------------------------------------+ -| *Getter* | is_overriding_selected_font_color() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | false | ++-----------+-----------------------------------------+ +| *Setter* | set_override_selected_font_color(value) | ++-----------+-----------------------------------------+ +| *Getter* | is_overriding_selected_font_color() | ++-----------+-----------------------------------------+ .. _class_TextEdit_property_readonly: - :ref:`bool` **readonly** -+----------+---------------------+ -| *Setter* | set_readonly(value) | -+----------+---------------------+ -| *Getter* | is_readonly() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_readonly(value) | ++-----------+---------------------+ +| *Getter* | is_readonly() | ++-----------+---------------------+ If ``true``, read-only mode is enabled. Existing text cannot be modified and new text cannot be added. @@ -507,11 +535,13 @@ If ``true``, read-only mode is enabled. Existing text cannot be modified and new - :ref:`bool` **show_line_numbers** -+----------+--------------------------------+ -| *Setter* | set_show_line_numbers(value) | -+----------+--------------------------------+ -| *Getter* | is_show_line_numbers_enabled() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | false | ++-----------+--------------------------------+ +| *Setter* | set_show_line_numbers(value) | ++-----------+--------------------------------+ +| *Getter* | is_show_line_numbers_enabled() | ++-----------+--------------------------------+ If ``true``, line numbers are displayed to the left of the text. @@ -519,11 +549,13 @@ If ``true``, line numbers are displayed to the left of the text. - :ref:`bool` **smooth_scrolling** -+----------+---------------------------------+ -| *Setter* | set_smooth_scroll_enable(value) | -+----------+---------------------------------+ -| *Getter* | is_smooth_scroll_enabled() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_smooth_scroll_enable(value) | ++-----------+---------------------------------+ +| *Getter* | is_smooth_scroll_enabled() | ++-----------+---------------------------------+ If ``true``, sets the ``step`` of the scrollbars to ``0.25`` which results in smoother scrolling. @@ -531,11 +563,13 @@ If ``true``, sets the ``step`` of the scrollbars to ``0.25`` which results in sm - :ref:`bool` **syntax_highlighting** -+----------+------------------------------+ -| *Setter* | set_syntax_coloring(value) | -+----------+------------------------------+ -| *Getter* | is_syntax_coloring_enabled() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_syntax_coloring(value) | ++-----------+------------------------------+ +| *Getter* | is_syntax_coloring_enabled() | ++-----------+------------------------------+ If ``true``, any custom color properties that have been set for this ``TextEdit`` will be visible. @@ -543,11 +577,13 @@ If ``true``, any custom color properties that have been set for this ``TextEdit` - :ref:`String` **text** -+----------+-----------------+ -| *Setter* | set_text(value) | -+----------+-----------------+ -| *Getter* | get_text() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | "" | ++-----------+-----------------+ +| *Setter* | set_text(value) | ++-----------+-----------------+ +| *Getter* | get_text() | ++-----------+-----------------+ String value of the ``TextEdit``. @@ -555,11 +591,13 @@ String value of the ``TextEdit``. - :ref:`float` **v_scroll_speed** -+----------+---------------------------+ -| *Setter* | set_v_scroll_speed(value) | -+----------+---------------------------+ -| *Getter* | get_v_scroll_speed() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 80.0 | ++-----------+---------------------------+ +| *Setter* | set_v_scroll_speed(value) | ++-----------+---------------------------+ +| *Getter* | get_v_scroll_speed() | ++-----------+---------------------------+ Vertical scroll sensitivity. @@ -567,11 +605,13 @@ Vertical scroll sensitivity. - :ref:`bool` **wrap_enabled** -+----------+-------------------------+ -| *Setter* | set_wrap_enabled(value) | -+----------+-------------------------+ -| *Getter* | is_wrap_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_wrap_enabled(value) | ++-----------+-------------------------+ +| *Getter* | is_wrap_enabled() | ++-----------+-------------------------+ If ``true``, enables text wrapping when it goes beyond the edge of what is visible. @@ -636,7 +676,7 @@ Returns the line the editing cursor is at. Moves the cursor at the specified ``column`` index. -If ``adjust_viewport`` is set to true, the viewport will center at the cursor position after the move occurs. Default value is ``true``. +If ``adjust_viewport`` is set to true, the viewport will center at the cursor position after the move occurs. .. _class_TextEdit_method_cursor_set_line: @@ -644,9 +684,9 @@ If ``adjust_viewport`` is set to true, the viewport will center at the cursor po Moves the cursor at the specified ``line`` index. -If ``adjust_viewport`` is set to true, the viewport will center at the cursor position after the move occurs. Default value is ``true``. +If ``adjust_viewport`` is set to true, the viewport will center at the cursor position after the move occurs. -If ``can_be_hidden`` is set to true, the specified ``line`` can be hidden using :ref:`set_line_as_hidden`. Default value is ``true``. +If ``can_be_hidden`` is set to true, the specified ``line`` can be hidden using :ref:`set_line_as_hidden`. .. _class_TextEdit_method_cut: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index f5a46961d..dd3b8a344 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -21,9 +21,9 @@ Texture for 2D and 3D. Properties ---------- -+-----------------------+--------------------------------------------+ -| :ref:`int` | :ref:`flags` | -+-----------------------+--------------------------------------------+ ++-----------------------+--------------------------------------------+---+ +| :ref:`int` | :ref:`flags` | 4 | ++-----------------------+--------------------------------------------+---+ Methods ------- @@ -69,7 +69,7 @@ Enumerations enum **Flags**: -- **FLAGS_DEFAULT** = **7** --- Default flags. :ref:`FLAG_MIPMAPS`, :ref:`FLAG_REPEAT` and :ref:`FLAG_FILTER` are are enabled. +- **FLAGS_DEFAULT** = **7** --- Default flags. :ref:`FLAG_MIPMAPS`, :ref:`FLAG_REPEAT` and :ref:`FLAG_FILTER` are enabled. - **FLAG_MIPMAPS** = **1** --- Generates mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. @@ -101,11 +101,13 @@ Property Descriptions - :ref:`int` **flags** -+----------+------------------+ -| *Setter* | set_flags(value) | -+----------+------------------+ -| *Getter* | get_flags() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 4 | ++-----------+------------------+ +| *Setter* | set_flags(value) | ++-----------+------------------+ +| *Getter* | get_flags() | ++-----------+------------------+ The texture's flags. diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index b146557d5..264aa9eaf 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -19,23 +19,23 @@ Texture-based button. Supports Pressed, Hover, Disabled and Focused states. Properties ---------- -+----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`expand` | -+----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`StretchMode` | :ref:`stretch_mode` | -+----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`BitMap` | :ref:`texture_click_mask` | -+----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_disabled` | -+----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_focused` | -+----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_hover` | -+----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_normal` | -+----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_pressed` | -+----------------------------------------------------+----------------------------------------------------------------------------+ ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`expand` | false | ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`StretchMode` | :ref:`stretch_mode` | 0 | ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`BitMap` | :ref:`texture_click_mask` | null | ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`texture_disabled` | null | ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`texture_focused` | null | ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`texture_hover` | null | ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`texture_normal` | null | ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`texture_pressed` | null | ++----------------------------------------------------+----------------------------------------------------------------------------+-------+ Enumerations ------------ @@ -86,23 +86,27 @@ Property Descriptions - :ref:`bool` **expand** -+----------+-------------------+ -| *Setter* | set_expand(value) | -+----------+-------------------+ -| *Getter* | get_expand() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_expand(value) | ++-----------+-------------------+ +| *Getter* | get_expand() | ++-----------+-------------------+ -If ``true``, the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false``, the texture will not scale with the node. Default value: ``false``. +If ``true``, the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false``, the texture will not scale with the node. .. _class_TextureButton_property_stretch_mode: - :ref:`StretchMode` **stretch_mode** -+----------+-------------------------+ -| *Setter* | set_stretch_mode(value) | -+----------+-------------------------+ -| *Getter* | get_stretch_mode() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_stretch_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_stretch_mode() | ++-----------+-------------------------+ Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH_*`` constants. See the constants to learn more. @@ -110,11 +114,13 @@ Controls the texture's behavior when you resize the node's bounding rectangle, * - :ref:`BitMap` **texture_click_mask** -+----------+-----------------------+ -| *Setter* | set_click_mask(value) | -+----------+-----------------------+ -| *Getter* | get_click_mask() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | null | ++-----------+-----------------------+ +| *Setter* | set_click_mask(value) | ++-----------+-----------------------+ +| *Getter* | get_click_mask() | ++-----------+-----------------------+ Pure black and white :ref:`BitMap` image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. @@ -122,11 +128,13 @@ Pure black and white :ref:`BitMap` image to use for click detectio - :ref:`Texture` **texture_disabled** -+----------+-----------------------------+ -| *Setter* | set_disabled_texture(value) | -+----------+-----------------------------+ -| *Getter* | get_disabled_texture() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | null | ++-----------+-----------------------------+ +| *Setter* | set_disabled_texture(value) | ++-----------+-----------------------------+ +| *Getter* | get_disabled_texture() | ++-----------+-----------------------------+ Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. @@ -134,11 +142,13 @@ Texture to display when the node is disabled. See :ref:`BaseButton.disabled` **texture_focused** -+----------+----------------------------+ -| *Setter* | set_focused_texture(value) | -+----------+----------------------------+ -| *Getter* | get_focused_texture() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | null | ++-----------+----------------------------+ +| *Setter* | set_focused_texture(value) | ++-----------+----------------------------+ +| *Getter* | get_focused_texture() | ++-----------+----------------------------+ Texture to display when the node has mouse or keyboard focus. @@ -146,11 +156,13 @@ Texture to display when the node has mouse or keyboard focus. - :ref:`Texture` **texture_hover** -+----------+--------------------------+ -| *Setter* | set_hover_texture(value) | -+----------+--------------------------+ -| *Getter* | get_hover_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_hover_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_hover_texture() | ++-----------+--------------------------+ Texture to display when the mouse hovers the node. @@ -158,11 +170,13 @@ Texture to display when the mouse hovers the node. - :ref:`Texture` **texture_normal** -+----------+---------------------------+ -| *Setter* | set_normal_texture(value) | -+----------+---------------------------+ -| *Getter* | get_normal_texture() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | null | ++-----------+---------------------------+ +| *Setter* | set_normal_texture(value) | ++-----------+---------------------------+ +| *Getter* | get_normal_texture() | ++-----------+---------------------------+ Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. @@ -170,11 +184,13 @@ Texture to display by default, when the node is **not** in the disabled, focused - :ref:`Texture` **texture_pressed** -+----------+----------------------------+ -| *Setter* | set_pressed_texture(value) | -+----------+----------------------------+ -| *Getter* | get_pressed_texture() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | null | ++-----------+----------------------------+ +| *Setter* | set_pressed_texture(value) | ++-----------+----------------------------+ +| *Getter* | get_pressed_texture() | ++-----------+----------------------------+ Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the Enter key or if the player presses the :ref:`BaseButton.shortcut` key. diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 347f959dc..09bf18f60 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -21,11 +21,11 @@ Brief Description Properties ---------- -+-------------------------------------+---------------------------------------------------+ -| :ref:`Dictionary` | :ref:`data` | -+-------------------------------------+---------------------------------------------------+ -| :ref:`int` | :ref:`flags` | -+-------------------------------------+---------------------------------------------------+ ++-------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`data` | { "depth": 0, "flags": 4, "format": 37, "height": 0, "layers": [ ], "width": 0 } | ++-------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`flags` | 4 | ++-------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------+ Methods ------- @@ -78,15 +78,21 @@ Property Descriptions - :ref:`Dictionary` **data** ++-----------+-----------------------------------------------------------------------------------+ +| *Default* | { "depth": 0, "flags": 4, "format": 37, "height": 0, "layers": [ ], "width": 0 } | ++-----------+-----------------------------------------------------------------------------------+ + .. _class_TextureLayered_property_flags: - :ref:`int` **flags** -+----------+------------------+ -| *Setter* | set_flags(value) | -+----------+------------------+ -| *Getter* | get_flags() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 4 | ++-----------+------------------+ +| *Setter* | set_flags(value) | ++-----------+------------------+ +| *Getter* | get_flags() | ++-----------+------------------+ Method Descriptions ------------------- diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 02ab768e7..aa79e2eb9 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -19,37 +19,37 @@ Texture-based progress bar. Useful for loading screens and life or stamina bars. Properties ---------- -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`fill_mode` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`nine_patch_stretch` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`radial_center_offset` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_fill_degrees` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_initial_angle` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_bottom` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_left` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_right` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_top` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_over` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_progress` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_under` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_over` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_progress` | -+-------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_under` | -+-------------------------------+------------------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`fill_mode` | 0 | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`nine_patch_stretch` | false | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`radial_center_offset` | Vector2( 0, 0 ) | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`radial_fill_degrees` | 360.0 | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`radial_initial_angle` | 0.0 | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`stretch_margin_bottom` | 0 | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`stretch_margin_left` | 0 | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`stretch_margin_right` | 0 | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`int` | :ref:`stretch_margin_top` | 0 | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture_over` | null | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture_progress` | null | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Texture` | :ref:`texture_under` | null | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`tint_over` | Color( 1, 1, 1, 1 ) | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`tint_progress` | Color( 1, 1, 1, 1 ) | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`tint_under` | Color( 1, 1, 1, 1 ) | ++-------------------------------+------------------------------------------------------------------------------------+---------------------+ Enumerations ------------ @@ -106,11 +106,13 @@ Property Descriptions - :ref:`int` **fill_mode** -+----------+----------------------+ -| *Setter* | set_fill_mode(value) | -+----------+----------------------+ -| *Getter* | get_fill_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_fill_mode(value) | ++-----------+----------------------+ +| *Getter* | get_fill_mode() | ++-----------+----------------------+ The fill direction. See :ref:`FillMode` for possible values. @@ -118,23 +120,27 @@ The fill direction. See :ref:`FillMode` for possi - :ref:`bool` **nine_patch_stretch** -+----------+-------------------------------+ -| *Setter* | set_nine_patch_stretch(value) | -+----------+-------------------------------+ -| *Getter* | get_nine_patch_stretch() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | false | ++-----------+-------------------------------+ +| *Setter* | set_nine_patch_stretch(value) | ++-----------+-------------------------------+ +| *Getter* | get_nine_patch_stretch() | ++-----------+-------------------------------+ -If ``true``, Godot treats the bar's textures like in :ref:`NinePatchRect`. Use the ``stretch_margin_*`` properties like :ref:`stretch_margin_bottom` to set up the nine patch's 3×3 grid. Default value: ``false``. +If ``true``, Godot treats the bar's textures like in :ref:`NinePatchRect`. Use the ``stretch_margin_*`` properties like :ref:`stretch_margin_bottom` to set up the nine patch's 3×3 grid. .. _class_TextureProgress_property_radial_center_offset: - :ref:`Vector2` **radial_center_offset** -+----------+---------------------------------+ -| *Setter* | set_radial_center_offset(value) | -+----------+---------------------------------+ -| *Getter* | get_radial_center_offset() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+---------------------------------+ +| *Setter* | set_radial_center_offset(value) | ++-----------+---------------------------------+ +| *Getter* | get_radial_center_offset() | ++-----------+---------------------------------+ Offsets :ref:`texture_progress` if :ref:`fill_mode` is :ref:`FILL_CLOCKWISE` or :ref:`FILL_COUNTER_CLOCKWISE`. @@ -142,11 +148,13 @@ Offsets :ref:`texture_progress` - :ref:`float` **radial_fill_degrees** -+----------+-------------------------+ -| *Setter* | set_fill_degrees(value) | -+----------+-------------------------+ -| *Getter* | get_fill_degrees() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 360.0 | ++-----------+-------------------------+ +| *Setter* | set_fill_degrees(value) | ++-----------+-------------------------+ +| *Getter* | get_fill_degrees() | ++-----------+-------------------------+ Upper limit for the fill of :ref:`texture_progress` if :ref:`fill_mode` is :ref:`FILL_CLOCKWISE` or :ref:`FILL_COUNTER_CLOCKWISE`. When the node's ``value`` is equal to its ``max_value``, the texture fills up to this angle. @@ -156,11 +164,13 @@ See :ref:`Range.value`, :ref:`Range.max_value` **radial_initial_angle** -+----------+---------------------------------+ -| *Setter* | set_radial_initial_angle(value) | -+----------+---------------------------------+ -| *Getter* | get_radial_initial_angle() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 0.0 | ++-----------+---------------------------------+ +| *Setter* | set_radial_initial_angle(value) | ++-----------+---------------------------------+ +| *Getter* | get_radial_initial_angle() | ++-----------+---------------------------------+ Starting angle for the fill of :ref:`texture_progress` if :ref:`fill_mode` is :ref:`FILL_CLOCKWISE` or :ref:`FILL_COUNTER_CLOCKWISE`. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards :ref:`radial_fill_degrees`. @@ -168,11 +178,13 @@ Starting angle for the fill of :ref:`texture_progress` **stretch_margin_bottom** -+----------+---------------------------+ -| *Setter* | set_stretch_margin(value) | -+----------+---------------------------+ -| *Getter* | get_stretch_margin() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_stretch_margin(value) | ++-----------+---------------------------+ +| *Getter* | get_stretch_margin() | ++-----------+---------------------------+ The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. @@ -180,11 +192,13 @@ The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's botto - :ref:`int` **stretch_margin_left** -+----------+---------------------------+ -| *Setter* | set_stretch_margin(value) | -+----------+---------------------------+ -| *Getter* | get_stretch_margin() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_stretch_margin(value) | ++-----------+---------------------------+ +| *Getter* | get_stretch_margin() | ++-----------+---------------------------+ The width of the 9-patch's left column. @@ -192,11 +206,13 @@ The width of the 9-patch's left column. - :ref:`int` **stretch_margin_right** -+----------+---------------------------+ -| *Setter* | set_stretch_margin(value) | -+----------+---------------------------+ -| *Getter* | get_stretch_margin() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_stretch_margin(value) | ++-----------+---------------------------+ +| *Getter* | get_stretch_margin() | ++-----------+---------------------------+ The width of the 9-patch's right column. @@ -204,11 +220,13 @@ The width of the 9-patch's right column. - :ref:`int` **stretch_margin_top** -+----------+---------------------------+ -| *Setter* | set_stretch_margin(value) | -+----------+---------------------------+ -| *Getter* | get_stretch_margin() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0 | ++-----------+---------------------------+ +| *Setter* | set_stretch_margin(value) | ++-----------+---------------------------+ +| *Getter* | get_stretch_margin() | ++-----------+---------------------------+ The height of the 9-patch's top row. @@ -216,11 +234,13 @@ The height of the 9-patch's top row. - :ref:`Texture` **texture_over** -+----------+-------------------------+ -| *Setter* | set_over_texture(value) | -+----------+-------------------------+ -| *Getter* | get_over_texture() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | null | ++-----------+-------------------------+ +| *Setter* | set_over_texture(value) | ++-----------+-------------------------+ +| *Getter* | get_over_texture() | ++-----------+-------------------------+ :ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. @@ -228,11 +248,13 @@ The height of the 9-patch's top row. - :ref:`Texture` **texture_progress** -+----------+-----------------------------+ -| *Setter* | set_progress_texture(value) | -+----------+-----------------------------+ -| *Getter* | get_progress_texture() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | null | ++-----------+-----------------------------+ +| *Setter* | set_progress_texture(value) | ++-----------+-----------------------------+ +| *Getter* | get_progress_texture() | ++-----------+-----------------------------+ :ref:`Texture` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. @@ -242,11 +264,13 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val - :ref:`Texture` **texture_under** -+----------+--------------------------+ -| *Setter* | set_under_texture(value) | -+----------+--------------------------+ -| *Getter* | get_under_texture() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | null | ++-----------+--------------------------+ +| *Setter* | set_under_texture(value) | ++-----------+--------------------------+ +| *Getter* | get_under_texture() | ++-----------+--------------------------+ :ref:`Texture` that draws under the progress bar. The bar's background. @@ -254,11 +278,13 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val - :ref:`Color` **tint_over** -+----------+----------------------+ -| *Setter* | set_tint_over(value) | -+----------+----------------------+ -| *Getter* | get_tint_over() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+----------------------+ +| *Setter* | set_tint_over(value) | ++-----------+----------------------+ +| *Getter* | get_tint_over() | ++-----------+----------------------+ Multiplies the color of the bar's ``texture_over`` texture. The effect is similar to :ref:`CanvasItem.modulate`, except it only affects this specific texture instead of the entire node. @@ -266,11 +292,13 @@ Multiplies the color of the bar's ``texture_over`` texture. The effect is simila - :ref:`Color` **tint_progress** -+----------+--------------------------+ -| *Setter* | set_tint_progress(value) | -+----------+--------------------------+ -| *Getter* | get_tint_progress() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+--------------------------+ +| *Setter* | set_tint_progress(value) | ++-----------+--------------------------+ +| *Getter* | get_tint_progress() | ++-----------+--------------------------+ Multiplies the color of the bar's ``texture_progress`` texture. @@ -278,11 +306,13 @@ Multiplies the color of the bar's ``texture_progress`` texture. - :ref:`Color` **tint_under** -+----------+-----------------------+ -| *Setter* | set_tint_under(value) | -+----------+-----------------------+ -| *Getter* | get_tint_under() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+-----------------------+ +| *Setter* | set_tint_under(value) | ++-----------+-----------------------+ +| *Getter* | get_tint_under() | ++-----------+-----------------------+ Multiplies the color of the bar's ``texture_under`` texture. diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 64c3c7960..e7ad8ef2c 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -19,17 +19,17 @@ Control for drawing textures. Properties ---------- -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`expand` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_h` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_v` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`StretchMode` | :ref:`stretch_mode` | -+--------------------------------------------------+--------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+--------------------------------------------------+--------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`expand` | false | ++--------------------------------------------------+--------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`flip_h` | false | ++--------------------------------------------------+--------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`flip_v` | false | ++--------------------------------------------------+--------------------------------------------------------------+-------+ +| :ref:`StretchMode` | :ref:`stretch_mode` | 0 | ++--------------------------------------------------+--------------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`texture` | null | ++--------------------------------------------------+--------------------------------------------------------------+-------+ Enumerations ------------ @@ -82,47 +82,55 @@ Property Descriptions - :ref:`bool` **expand** -+----------+-------------------+ -| *Setter* | set_expand(value) | -+----------+-------------------+ -| *Getter* | has_expand() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_expand(value) | ++-----------+-------------------+ +| *Getter* | has_expand() | ++-----------+-------------------+ -If ``true``, the texture scales to fit its bounding rectangle. Default value: ``false``. +If ``true``, the texture scales to fit its bounding rectangle. .. _class_TextureRect_property_flip_h: - :ref:`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_TextureRect_property_flip_v: - :ref:`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_TextureRect_property_stretch_mode: - :ref:`StretchMode` **stretch_mode** -+----------+-------------------------+ -| *Setter* | set_stretch_mode(value) | -+----------+-------------------------+ -| *Getter* | get_stretch_mode() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_stretch_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_stretch_mode() | ++-----------+-------------------------+ Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. @@ -130,11 +138,13 @@ Controls the texture's behavior when resizing the node's bounding rectangle. See - :ref:`Texture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ The node's :ref:`Texture` resource. diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 8ae1bfb7f..d1c1c24e7 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -19,9 +19,9 @@ Theme for controls. Properties ---------- -+-------------------------+--------------------------------------------------------+ -| :ref:`Font` | :ref:`default_font` | -+-------------------------+--------------------------------------------------------+ ++-------------------------+--------------------------------------------------------+------+ +| :ref:`Font` | :ref:`default_font` | null | ++-------------------------+--------------------------------------------------------+------+ Methods ------- @@ -107,11 +107,13 @@ Property Descriptions - :ref:`Font` **default_font** -+----------+-------------------------+ -| *Setter* | set_default_font(value) | -+----------+-------------------------+ -| *Getter* | get_default_font() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | null | ++-----------+-------------------------+ +| *Setter* | set_default_font(value) | ++-----------+-------------------------+ +| *Getter* | get_default_font() | ++-----------+-------------------------+ The theme's default font. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 97b89d06c..d1dcc9ed7 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -19,37 +19,39 @@ Node for 2D tile-based maps. Properties ---------- -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_clip_uv` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`cell_custom_transform` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`HalfOffset` | :ref:`cell_half_offset` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cell_quadrant_size` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cell_size` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`TileOrigin` | :ref:`cell_tile_origin` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_y_sort` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`collision_bounce` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`collision_friction` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collision_use_kinematic` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`occluder_light_mask` | -+--------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`TileSet` | :ref:`tile_set` | -+--------------------------------------------+--------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`bool` | :ref:`cell_clip_uv` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Transform2D` | :ref:`cell_custom_transform` | Transform2D( 1, 0, 0, 1, 0, 0 ) | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`HalfOffset` | :ref:`cell_half_offset` | 2 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`int` | :ref:`cell_quadrant_size` | 16 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Vector2` | :ref:`cell_size` | Vector2( 64, 64 ) | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`TileOrigin` | :ref:`cell_tile_origin` | 0 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`bool` | :ref:`cell_y_sort` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`float` | :ref:`collision_bounce` | 0.0 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`float` | :ref:`collision_friction` | 1.0 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`int` | :ref:`collision_layer` | 1 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`int` | :ref:`collision_mask` | 1 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`bool` | :ref:`collision_use_kinematic` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`bool` | :ref:`collision_use_parent` | false | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`Mode` | :ref:`mode` | 0 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`int` | :ref:`occluder_light_mask` | 1 | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ +| :ref:`TileSet` | :ref:`tile_set` | null | ++--------------------------------------------+--------------------------------------------------------------------------------+---------------------------------+ Methods ------- @@ -192,21 +194,25 @@ Property Descriptions - :ref:`bool` **cell_clip_uv** -+----------+--------------------+ -| *Setter* | set_clip_uv(value) | -+----------+--------------------+ -| *Getter* | get_clip_uv() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | false | ++-----------+--------------------+ +| *Setter* | set_clip_uv(value) | ++-----------+--------------------+ +| *Getter* | get_clip_uv() | ++-----------+--------------------+ .. _class_TileMap_property_cell_custom_transform: - :ref:`Transform2D` **cell_custom_transform** -+----------+-----------------------------+ -| *Setter* | set_custom_transform(value) | -+----------+-----------------------------+ -| *Getter* | get_custom_transform() | -+----------+-----------------------------+ ++-----------+---------------------------------+ +| *Default* | Transform2D( 1, 0, 0, 1, 0, 0 ) | ++-----------+---------------------------------+ +| *Setter* | set_custom_transform(value) | ++-----------+---------------------------------+ +| *Getter* | get_custom_transform() | ++-----------+---------------------------------+ The custom :ref:`Transform2D` to be applied to the TileMap's cells. @@ -214,35 +220,41 @@ The custom :ref:`Transform2D` to be applied to the TileMap's - :ref:`HalfOffset` **cell_half_offset** -+----------+------------------------+ -| *Setter* | set_half_offset(value) | -+----------+------------------------+ -| *Getter* | get_half_offset() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 2 | ++-----------+------------------------+ +| *Setter* | set_half_offset(value) | ++-----------+------------------------+ +| *Getter* | get_half_offset() | ++-----------+------------------------+ -Amount to offset alternating tiles. See :ref:`HalfOffset` for possible values. Default value: ``HALF_OFFSET_DISABLED``. +Amount to offset alternating tiles. See :ref:`HalfOffset` for possible values. .. _class_TileMap_property_cell_quadrant_size: - :ref:`int` **cell_quadrant_size** -+----------+--------------------------+ -| *Setter* | set_quadrant_size(value) | -+----------+--------------------------+ -| *Getter* | get_quadrant_size() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 16 | ++-----------+--------------------------+ +| *Setter* | set_quadrant_size(value) | ++-----------+--------------------------+ +| *Getter* | get_quadrant_size() | ++-----------+--------------------------+ -The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. +The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. .. _class_TileMap_property_cell_size: - :ref:`Vector2` **cell_size** -+----------+----------------------+ -| *Setter* | set_cell_size(value) | -+----------+----------------------+ -| *Getter* | get_cell_size() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | Vector2( 64, 64 ) | ++-----------+----------------------+ +| *Setter* | set_cell_size(value) | ++-----------+----------------------+ +| *Getter* | get_cell_size() | ++-----------+----------------------+ The TileMap's cell size. @@ -250,59 +262,69 @@ The TileMap's cell size. - :ref:`TileOrigin` **cell_tile_origin** -+----------+------------------------+ -| *Setter* | set_tile_origin(value) | -+----------+------------------------+ -| *Getter* | get_tile_origin() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_tile_origin(value) | ++-----------+------------------------+ +| *Getter* | get_tile_origin() | ++-----------+------------------------+ -Position for tile origin. See :ref:`TileOrigin` for possible values. Default value: ``TILE_ORIGIN_TOP_LEFT``. +Position for tile origin. See :ref:`TileOrigin` for possible values. .. _class_TileMap_property_cell_y_sort: - :ref:`bool` **cell_y_sort** -+----------+--------------------------+ -| *Setter* | set_y_sort_mode(value) | -+----------+--------------------------+ -| *Getter* | is_y_sort_mode_enabled() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_y_sort_mode(value) | ++-----------+--------------------------+ +| *Getter* | is_y_sort_mode_enabled() | ++-----------+--------------------------+ -If ``true``, the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. +If ``true``, the TileMap's children will be drawn in order of their Y coordinate. .. _class_TileMap_property_collision_bounce: - :ref:`float` **collision_bounce** -+----------+-----------------------------+ -| *Setter* | set_collision_bounce(value) | -+----------+-----------------------------+ -| *Getter* | get_collision_bounce() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0.0 | ++-----------+-----------------------------+ +| *Setter* | set_collision_bounce(value) | ++-----------+-----------------------------+ +| *Getter* | get_collision_bounce() | ++-----------+-----------------------------+ -Bounce value for static body collisions (see ``collision_use_kinematic``). Default value: 0. +Bounce value for static body collisions (see ``collision_use_kinematic``). .. _class_TileMap_property_collision_friction: - :ref:`float` **collision_friction** -+----------+-------------------------------+ -| *Setter* | set_collision_friction(value) | -+----------+-------------------------------+ -| *Getter* | get_collision_friction() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 1.0 | ++-----------+-------------------------------+ +| *Setter* | set_collision_friction(value) | ++-----------+-------------------------------+ +| *Getter* | get_collision_friction() | ++-----------+-------------------------------+ -Friction value for static body collisions (see ``collision_use_kinematic``). Default value: 1. +Friction value for static body collisions (see ``collision_use_kinematic``). .. _class_TileMap_property_collision_layer: - :ref:`int` **collision_layer** -+----------+----------------------------+ -| *Setter* | set_collision_layer(value) | -+----------+----------------------------+ -| *Getter* | get_collision_layer() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 1 | ++-----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++-----------+----------------------------+ +| *Getter* | get_collision_layer() | ++-----------+----------------------------+ The collision layer(s) for all colliders in the TileMap. @@ -310,11 +332,13 @@ The collision layer(s) for all colliders in the TileMap. - :ref:`int` **collision_mask** -+----------+---------------------------+ -| *Setter* | set_collision_mask(value) | -+----------+---------------------------+ -| *Getter* | get_collision_mask() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++-----------+---------------------------+ +| *Getter* | get_collision_mask() | ++-----------+---------------------------+ The collision mask(s) for all colliders in the TileMap. @@ -322,35 +346,53 @@ The collision mask(s) for all colliders in the TileMap. - :ref:`bool` **collision_use_kinematic** -+----------+------------------------------------+ -| *Setter* | set_collision_use_kinematic(value) | -+----------+------------------------------------+ -| *Getter* | get_collision_use_kinematic() | -+----------+------------------------------------+ ++-----------+------------------------------------+ +| *Default* | false | ++-----------+------------------------------------+ +| *Setter* | set_collision_use_kinematic(value) | ++-----------+------------------------------------+ +| *Getter* | get_collision_use_kinematic() | ++-----------+------------------------------------+ -If ``true``, TileMap collisions will be handled as a kinematic body. If ``false``, collisions will be handled as static body. Default value: ``false``. +If ``true``, TileMap collisions will be handled as a kinematic body. If ``false``, collisions will be handled as static body. + +.. _class_TileMap_property_collision_use_parent: + +- :ref:`bool` **collision_use_parent** + ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_collision_use_parent(value) | ++-----------+---------------------------------+ +| *Getter* | get_collision_use_parent() | ++-----------+---------------------------------+ .. _class_TileMap_property_mode: - :ref:`Mode` **mode** -+----------+-----------------+ -| *Setter* | set_mode(value) | -+----------+-----------------+ -| *Getter* | get_mode() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_mode(value) | ++-----------+-----------------+ +| *Getter* | get_mode() | ++-----------+-----------------+ -The TileMap orientation mode. See :ref:`Mode` for possible values. Default value: ``MODE_SQUARE``. +The TileMap orientation mode. See :ref:`Mode` for possible values. .. _class_TileMap_property_occluder_light_mask: - :ref:`int` **occluder_light_mask** -+----------+--------------------------------+ -| *Setter* | set_occluder_light_mask(value) | -+----------+--------------------------------+ -| *Getter* | get_occluder_light_mask() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 1 | ++-----------+--------------------------------+ +| *Setter* | set_occluder_light_mask(value) | ++-----------+--------------------------------+ +| *Getter* | get_occluder_light_mask() | ++-----------+--------------------------------+ The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). @@ -358,11 +400,13 @@ The light mask assigned to all light occluders in the TileMap. The TileSet's lig - :ref:`TileSet` **tile_set** -+----------+--------------------+ -| *Setter* | set_tileset(value) | -+----------+--------------------+ -| *Getter* | get_tileset() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_tileset(value) | ++-----------+--------------------+ +| *Getter* | get_tileset() | ++-----------+--------------------+ The assigned :ref:`TileSet`. diff --git a/classes/class_timer.rst b/classes/class_timer.rst index f352fad6d..64c7e06d6 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -19,19 +19,19 @@ A countdown timer. Properties ---------- -+------------------------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`autostart` | -+------------------------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+------------------------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`paused` | -+------------------------------------------------------+--------------------------------------------------------+ -| :ref:`TimerProcessMode` | :ref:`process_mode` | -+------------------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`time_left` | -+------------------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`wait_time` | -+------------------------------------------------------+--------------------------------------------------------+ ++------------------------------------------------------+--------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`autostart` | false | ++------------------------------------------------------+--------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`one_shot` | false | ++------------------------------------------------------+--------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`paused` | | ++------------------------------------------------------+--------------------------------------------------------+-------+ +| :ref:`TimerProcessMode` | :ref:`process_mode` | 1 | ++------------------------------------------------------+--------------------------------------------------------+-------+ +| :ref:`float` | :ref:`time_left` | | ++------------------------------------------------------+--------------------------------------------------------+-------+ +| :ref:`float` | :ref:`wait_time` | 1.0 | ++------------------------------------------------------+--------------------------------------------------------+-------+ Methods ------- @@ -80,25 +80,29 @@ Property Descriptions - :ref:`bool` **autostart** -+----------+----------------------+ -| *Setter* | set_autostart(value) | -+----------+----------------------+ -| *Getter* | has_autostart() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_autostart(value) | ++-----------+----------------------+ +| *Getter* | has_autostart() | ++-----------+----------------------+ -If ``true``, the timer will automatically start when entering the scene tree. Default value: ``false``. +If ``true``, the timer will automatically start when entering the scene tree. .. _class_Timer_property_one_shot: - :ref:`bool` **one_shot** -+----------+---------------------+ -| *Setter* | set_one_shot(value) | -+----------+---------------------+ -| *Getter* | is_one_shot() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_one_shot(value) | ++-----------+---------------------+ +| *Getter* | is_one_shot() | ++-----------+---------------------+ -If ``true``, the timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``. +If ``true``, the timer will stop when reaching 0. If ``false``, it will restart. .. _class_Timer_property_paused: @@ -116,11 +120,13 @@ If ``true``, the timer is paused and will not process until it is unpaused again - :ref:`TimerProcessMode` **process_mode** -+----------+-------------------------------+ -| *Setter* | set_timer_process_mode(value) | -+----------+-------------------------------+ -| *Getter* | get_timer_process_mode() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 1 | ++-----------+-------------------------------+ +| *Setter* | set_timer_process_mode(value) | ++-----------+-------------------------------+ +| *Getter* | get_timer_process_mode() | ++-----------+-------------------------------+ Processing mode. See :ref:`TimerProcessMode`. @@ -140,11 +146,13 @@ The timer's remaining time in seconds. Returns 0 if the timer is inactive. - :ref:`float` **wait_time** -+----------+----------------------+ -| *Setter* | set_wait_time(value) | -+----------+----------------------+ -| *Getter* | get_wait_time() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 1.0 | ++-----------+----------------------+ +| *Setter* | set_wait_time(value) | ++-----------+----------------------+ +| *Getter* | get_wait_time() | ++-----------+----------------------+ Wait time in seconds. diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index 693b637f8..f8141f4d1 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -19,29 +19,29 @@ Flat button helper class. Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`StyleBox` | disabled | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | focus | -+---------------------------------+---------------------+ -| :ref:`Font` | font | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_disabled | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_hover | -+---------------------------------+---------------------+ -| :ref:`Color` | font_color_pressed | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | hover | -+---------------------------------+---------------------+ -| :ref:`int` | hseparation | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | normal | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | pressed | -+---------------------------------+---------------------+ ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | disabled | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | focus | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.95, 1, 0.3 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | hover | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`int` | hseparation | 3 | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | normal | | ++---------------------------------+---------------------+------------------------------------------+ +| :ref:`StyleBox` | pressed | | ++---------------------------------+---------------------+------------------------------------------+ Description ----------- diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 049a99476..af62e5d35 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -19,25 +19,25 @@ Button for touch screen devices. Properties ---------- -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`action` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`BitMap` | :ref:`bitmask` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`passby_press` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`pressed` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`shape` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shape_centered` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shape_visible` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`VisibilityMode` | :ref:`visibility_mode` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`action` | "" | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`BitMap` | :ref:`bitmask` | null | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`normal` | null | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`passby_press` | false | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`Texture` | :ref:`pressed` | null | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`Shape2D` | :ref:`shape` | null | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`shape_centered` | true | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`shape_visible` | true | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`VisibilityMode` | :ref:`visibility_mode` | 0 | ++--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ Methods ------- @@ -88,11 +88,13 @@ Property Descriptions - :ref:`String` **action** -+----------+-------------------+ -| *Setter* | set_action(value) | -+----------+-------------------+ -| *Getter* | get_action() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | "" | ++-----------+-------------------+ +| *Setter* | set_action(value) | ++-----------+-------------------+ +| *Getter* | get_action() | ++-----------+-------------------+ The button's action. Actions can be handled with :ref:`InputEventAction`. @@ -100,11 +102,13 @@ The button's action. Actions can be handled with :ref:`InputEventAction` **bitmask** -+----------+--------------------+ -| *Setter* | set_bitmask(value) | -+----------+--------------------+ -| *Getter* | get_bitmask() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_bitmask(value) | ++-----------+--------------------+ +| *Getter* | get_bitmask() | ++-----------+--------------------+ The button's bitmask. @@ -112,11 +116,13 @@ The button's bitmask. - :ref:`Texture` **normal** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ The button's texture for the normal state. @@ -124,11 +130,13 @@ The button's texture for the normal state. - :ref:`bool` **passby_press** -+----------+---------------------------+ -| *Setter* | set_passby_press(value) | -+----------+---------------------------+ -| *Getter* | is_passby_press_enabled() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_passby_press(value) | ++-----------+---------------------------+ +| *Getter* | is_passby_press_enabled() | ++-----------+---------------------------+ If ``true``, pass-by presses are enabled. @@ -136,11 +144,13 @@ If ``true``, pass-by presses are enabled. - :ref:`Texture` **pressed** -+----------+----------------------------+ -| *Setter* | set_texture_pressed(value) | -+----------+----------------------------+ -| *Getter* | get_texture_pressed() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | null | ++-----------+----------------------------+ +| *Setter* | set_texture_pressed(value) | ++-----------+----------------------------+ +| *Getter* | get_texture_pressed() | ++-----------+----------------------------+ The button's texture for the pressed state. @@ -148,11 +158,13 @@ The button's texture for the pressed state. - :ref:`Shape2D` **shape** -+----------+------------------+ -| *Setter* | set_shape(value) | -+----------+------------------+ -| *Getter* | get_shape() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | null | ++-----------+------------------+ +| *Setter* | set_shape(value) | ++-----------+------------------+ +| *Getter* | get_shape() | ++-----------+------------------+ The button's shape. @@ -160,11 +172,13 @@ The button's shape. - :ref:`bool` **shape_centered** -+----------+---------------------------+ -| *Setter* | set_shape_centered(value) | -+----------+---------------------------+ -| *Getter* | is_shape_centered() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | true | ++-----------+---------------------------+ +| *Setter* | set_shape_centered(value) | ++-----------+---------------------------+ +| *Getter* | is_shape_centered() | ++-----------+---------------------------+ If ``true``, the button's shape is centered. @@ -172,11 +186,13 @@ If ``true``, the button's shape is centered. - :ref:`bool` **shape_visible** -+----------+--------------------------+ -| *Setter* | set_shape_visible(value) | -+----------+--------------------------+ -| *Getter* | is_shape_visible() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | true | ++-----------+--------------------------+ +| *Setter* | set_shape_visible(value) | ++-----------+--------------------------+ +| *Getter* | is_shape_visible() | ++-----------+--------------------------+ If ``true``, the button's shape is visible. @@ -184,11 +200,13 @@ If ``true``, the button's shape is visible. - :ref:`VisibilityMode` **visibility_mode** -+----------+----------------------------+ -| *Setter* | set_visibility_mode(value) | -+----------+----------------------------+ -| *Getter* | get_visibility_mode() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_visibility_mode(value) | ++-----------+----------------------------+ +| *Getter* | get_visibility_mode() | ++-----------+----------------------------+ The button's visibility mode. See :ref:`VisibilityMode` for possible values. diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 92b3c9310..9d57da16f 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -17,11 +17,11 @@ Brief Description Properties ---------- -+-------------------------------+------------------------------------------------+ -| :ref:`Basis` | :ref:`basis` | -+-------------------------------+------------------------------------------------+ -| :ref:`Vector3` | :ref:`origin` | -+-------------------------------+------------------------------------------------+ ++-------------------------------+------------------------------------------------+------------------------------------+ +| :ref:`Basis` | :ref:`basis` | Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 ) | ++-------------------------------+------------------------------------------------+------------------------------------+ +| :ref:`Vector3` | :ref:`origin` | Vector3( 0, 0, 0 ) | ++-------------------------------+------------------------------------------------+------------------------------------+ Methods ------- @@ -96,12 +96,20 @@ Property Descriptions - :ref:`Basis` **basis** ++-----------+------------------------------------+ +| *Default* | Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 ) | ++-----------+------------------------------------+ + The basis is a matrix containing 3 :ref:`Vector3` as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. .. _class_Transform_property_origin: - :ref:`Vector3` **origin** ++-----------+--------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+--------------------+ + The translation offset of the transform. Method Descriptions diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 1819b396c..1fc6d9368 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -17,13 +17,13 @@ Brief Description Properties ---------- -+-------------------------------+--------------------------------------------------+ -| :ref:`Vector2` | :ref:`origin` | -+-------------------------------+--------------------------------------------------+ -| :ref:`Vector2` | :ref:`x` | -+-------------------------------+--------------------------------------------------+ -| :ref:`Vector2` | :ref:`y` | -+-------------------------------+--------------------------------------------------+ ++-------------------------------+--------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`origin` | Vector2( 0, 0 ) | ++-------------------------------+--------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`x` | Vector2( 1, 0 ) | ++-------------------------------+--------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`y` | Vector2( 0, 1 ) | ++-------------------------------+--------------------------------------------------+-----------------+ Methods ------- @@ -91,18 +91,30 @@ Property Descriptions - :ref:`Vector2` **origin** ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ + The transform's translation offset. .. _class_Transform2D_property_x: - :ref:`Vector2` **x** ++-----------+-----------------+ +| *Default* | Vector2( 1, 0 ) | ++-----------+-----------------+ + The X axis of 2×2 basis matrix containing 2 :ref:`Vector2`\ s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. .. _class_Transform2D_property_y: - :ref:`Vector2` **y** ++-----------+-----------------+ +| *Default* | Vector2( 0, 1 ) | ++-----------+-----------------+ + The Y axis of 2×2 basis matrix containing 2 :ref:`Vector2`\ s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. Method Descriptions diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 4da8c094a..721acc3ce 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -21,9 +21,9 @@ Language Translation. Properties ---------- -+-----------------------------+--------------------------------------------------+ -| :ref:`String` | :ref:`locale` | -+-----------------------------+--------------------------------------------------+ ++-----------------------------+--------------------------------------------------+------+ +| :ref:`String` | :ref:`locale` | "en" | ++-----------------------------+--------------------------------------------------+------+ Methods ------- @@ -59,11 +59,13 @@ Property Descriptions - :ref:`String` **locale** -+----------+-------------------+ -| *Setter* | set_locale(value) | -+----------+-------------------+ -| *Getter* | get_locale() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | "en" | ++-----------+-------------------+ +| *Setter* | set_locale(value) | ++-----------+-------------------+ +| *Getter* | get_locale() | ++-----------+-------------------+ The locale of the translation. diff --git a/classes/class_tree.rst b/classes/class_tree.rst index e7d805bcf..2ff8d6e2e 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -19,21 +19,21 @@ Control to show a tree of items. Properties ---------- -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_reselect` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_rmb_select` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`columns` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`drop_mode_flags` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_folding` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_root` | -+-----------------------------------------+---------------------------------------------------------------+ -| :ref:`SelectMode` | :ref:`select_mode` | -+-----------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------+---------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`allow_reselect` | false | ++-----------------------------------------+---------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`allow_rmb_select` | false | ++-----------------------------------------+---------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`columns` | 1 | ++-----------------------------------------+---------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`drop_mode_flags` | 0 | ++-----------------------------------------+---------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`hide_folding` | false | ++-----------------------------------------+---------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`hide_root` | false | ++-----------------------------------------+---------------------------------------------------------------+-------+ +| :ref:`SelectMode` | :ref:`select_mode` | 0 | ++-----------------------------------------+---------------------------------------------------------------+-------+ Methods ------- @@ -89,85 +89,85 @@ Methods Theme Properties ---------------- -+---------------------------------+------------------------------+ -| :ref:`Texture` | arrow | -+---------------------------------+------------------------------+ -| :ref:`Texture` | arrow_collapsed | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | bg | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | bg_focus | -+---------------------------------+------------------------------+ -| :ref:`int` | button_margin | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | button_pressed | -+---------------------------------+------------------------------+ -| :ref:`Texture` | checked | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | cursor | -+---------------------------------+------------------------------+ -| :ref:`Color` | cursor_color | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | cursor_unfocused | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | custom_button | -+---------------------------------+------------------------------+ -| :ref:`Color` | custom_button_font_highlight | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | custom_button_hover | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | custom_button_pressed | -+---------------------------------+------------------------------+ -| :ref:`int` | draw_guides | -+---------------------------------+------------------------------+ -| :ref:`int` | draw_relationship_lines | -+---------------------------------+------------------------------+ -| :ref:`Color` | drop_position_color | -+---------------------------------+------------------------------+ -| :ref:`Font` | font | -+---------------------------------+------------------------------+ -| :ref:`Color` | font_color | -+---------------------------------+------------------------------+ -| :ref:`Color` | font_color_selected | -+---------------------------------+------------------------------+ -| :ref:`Color` | guide_color | -+---------------------------------+------------------------------+ -| :ref:`int` | guide_width | -+---------------------------------+------------------------------+ -| :ref:`int` | hseparation | -+---------------------------------+------------------------------+ -| :ref:`int` | item_margin | -+---------------------------------+------------------------------+ -| :ref:`Color` | relationship_line_color | -+---------------------------------+------------------------------+ -| :ref:`int` | scroll_border | -+---------------------------------+------------------------------+ -| :ref:`int` | scroll_speed | -+---------------------------------+------------------------------+ -| :ref:`Texture` | select_arrow | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | selected | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | selected_focus | -+---------------------------------+------------------------------+ -| :ref:`Color` | selection_color | -+---------------------------------+------------------------------+ -| :ref:`Color` | title_button_color | -+---------------------------------+------------------------------+ -| :ref:`Font` | title_button_font | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | title_button_hover | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | title_button_normal | -+---------------------------------+------------------------------+ -| :ref:`StyleBox` | title_button_pressed | -+---------------------------------+------------------------------+ -| :ref:`Texture` | unchecked | -+---------------------------------+------------------------------+ -| :ref:`Texture` | updown | -+---------------------------------+------------------------------+ -| :ref:`int` | vseparation | -+---------------------------------+------------------------------+ ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Texture` | arrow | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Texture` | arrow_collapsed | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | bg | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | bg_focus | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | button_margin | 4 | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | button_pressed | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Texture` | checked | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | cursor | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | cursor_color | Color( 0, 0, 0, 1 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | cursor_unfocused | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | custom_button | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | custom_button_font_highlight | Color( 0.941176, 0.941176, 0.941176, 1 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | custom_button_hover | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | custom_button_pressed | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | draw_guides | 1 | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | draw_relationship_lines | 0 | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | drop_position_color | Color( 1, 0.3, 0.2, 1 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Font` | font | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | font_color | Color( 0.690196, 0.690196, 0.690196, 1 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | font_color_selected | Color( 1, 1, 1, 1 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | guide_color | Color( 0, 0, 0, 0.1 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | guide_width | 2 | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | hseparation | 4 | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | item_margin | 12 | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | relationship_line_color | Color( 0.27451, 0.27451, 0.27451, 1 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | scroll_border | 4 | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | scroll_speed | 12 | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Texture` | select_arrow | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | selected | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | selected_focus | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | selection_color | Color( 0.1, 0.1, 1, 0.8 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Color` | title_button_color | Color( 0.878431, 0.878431, 0.878431, 1 ) | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Font` | title_button_font | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | title_button_hover | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | title_button_normal | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`StyleBox` | title_button_pressed | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Texture` | unchecked | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`Texture` | updown | | ++---------------------------------+------------------------------+------------------------------------------+ +| :ref:`int` | vseparation | 4 | ++---------------------------------+------------------------------+------------------------------------------+ Signals ------- @@ -322,11 +322,13 @@ Property Descriptions - :ref:`bool` **allow_reselect** -+----------+---------------------------+ -| *Setter* | set_allow_reselect(value) | -+----------+---------------------------+ -| *Getter* | get_allow_reselect() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_allow_reselect(value) | ++-----------+---------------------------+ +| *Getter* | get_allow_reselect() | ++-----------+---------------------------+ If ``true``, the currently selected cell may be selected again. @@ -334,11 +336,13 @@ If ``true``, the currently selected cell may be selected again. - :ref:`bool` **allow_rmb_select** -+----------+-----------------------------+ -| *Setter* | set_allow_rmb_select(value) | -+----------+-----------------------------+ -| *Getter* | get_allow_rmb_select() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | false | ++-----------+-----------------------------+ +| *Setter* | set_allow_rmb_select(value) | ++-----------+-----------------------------+ +| *Getter* | get_allow_rmb_select() | ++-----------+-----------------------------+ If ``true``, a right mouse button click can select items. @@ -346,11 +350,13 @@ If ``true``, a right mouse button click can select items. - :ref:`int` **columns** -+----------+--------------------+ -| *Setter* | set_columns(value) | -+----------+--------------------+ -| *Getter* | get_columns() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | 1 | ++-----------+--------------------+ +| *Setter* | set_columns(value) | ++-----------+--------------------+ +| *Getter* | get_columns() | ++-----------+--------------------+ The number of columns. @@ -358,11 +364,13 @@ The number of columns. - :ref:`int` **drop_mode_flags** -+----------+----------------------------+ -| *Setter* | set_drop_mode_flags(value) | -+----------+----------------------------+ -| *Getter* | get_drop_mode_flags() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_drop_mode_flags(value) | ++-----------+----------------------------+ +| *Getter* | get_drop_mode_flags() | ++-----------+----------------------------+ The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once dropping is done, reverts to :ref:`DROP_MODE_DISABLED`. Setting this during :ref:`Control.can_drop_data` is recommended. @@ -370,11 +378,13 @@ The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once - :ref:`bool` **hide_folding** -+----------+-------------------------+ -| *Setter* | set_hide_folding(value) | -+----------+-------------------------+ -| *Getter* | is_folding_hidden() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | false | ++-----------+-------------------------+ +| *Setter* | set_hide_folding(value) | ++-----------+-------------------------+ +| *Getter* | is_folding_hidden() | ++-----------+-------------------------+ If ``true``, the folding arrow is hidden. @@ -382,11 +392,13 @@ If ``true``, the folding arrow is hidden. - :ref:`bool` **hide_root** -+----------+----------------------+ -| *Setter* | set_hide_root(value) | -+----------+----------------------+ -| *Getter* | is_root_hidden() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_hide_root(value) | ++-----------+----------------------+ +| *Getter* | is_root_hidden() | ++-----------+----------------------+ If ``true``, the tree's root is hidden. @@ -394,11 +406,13 @@ If ``true``, the tree's root is hidden. - :ref:`SelectMode` **select_mode** -+----------+------------------------+ -| *Setter* | set_select_mode(value) | -+----------+------------------------+ -| *Getter* | get_select_mode() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_select_mode(value) | ++-----------+------------------------+ +| *Getter* | get_select_mode() | ++-----------+------------------------+ Allows single or multiple selection. See the ``SELECT_*`` constants. diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 76b5c9ead..505fba314 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -19,13 +19,13 @@ Smoothly animates a node's properties over time. Properties ---------- -+------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`TweenProcessMode` | :ref:`playback_process_mode` | -+------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`playback_speed` | -+------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`repeat` | -+------------------------------------------------------+--------------------------------------------------------------------------+ ++------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`TweenProcessMode` | :ref:`playback_process_mode` | 1 | ++------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`float` | :ref:`playback_speed` | 1.0 | ++------------------------------------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`repeat` | false | ++------------------------------------------------------+--------------------------------------------------------------------------+-------+ Methods ------- @@ -212,23 +212,27 @@ Property Descriptions - :ref:`TweenProcessMode` **playback_process_mode** -+----------+-------------------------------+ -| *Setter* | set_tween_process_mode(value) | -+----------+-------------------------------+ -| *Getter* | get_tween_process_mode() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 1 | ++-----------+-------------------------------+ +| *Setter* | set_tween_process_mode(value) | ++-----------+-------------------------------+ +| *Getter* | get_tween_process_mode() | ++-----------+-------------------------------+ -The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. +The tween's animation process thread. See :ref:`TweenProcessMode`. .. _class_Tween_property_playback_speed: - :ref:`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 tween's speed multiplier. For example, set it to ``1.0`` for normal speed, ``2.0`` for two times normal speed, or ``0.5`` for half of the normal speed. A value of ``0`` pauses the animation, but see also :ref:`set_active` or :ref:`stop_all` for this. @@ -236,11 +240,13 @@ The tween's speed multiplier. For example, set it to ``1.0`` for normal speed, ` - :ref:`bool` **repeat** -+----------+-------------------+ -| *Setter* | set_repeat(value) | -+----------+-------------------+ -| *Getter* | is_repeat() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_repeat(value) | ++-----------+-------------------+ +| *Getter* | is_repeat() | ++-----------+-------------------+ If ``true``, the tween loops. diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index a979ac8b3..c8cd6ae4d 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -19,13 +19,13 @@ UPNP network functions. Properties ---------- -+-----------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`discover_ipv6` | -+-----------------------------+-------------------------------------------------------------------------+ -| :ref:`int` | :ref:`discover_local_port` | -+-----------------------------+-------------------------------------------------------------------------+ -| :ref:`String` | :ref:`discover_multicast_if` | -+-----------------------------+-------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`discover_ipv6` | false | ++-----------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`discover_local_port` | 0 | ++-----------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`discover_multicast_if` | "" | ++-----------------------------+-------------------------------------------------------------------------+-------+ Methods ------- @@ -204,11 +204,13 @@ Property Descriptions - :ref:`bool` **discover_ipv6** -+----------+--------------------------+ -| *Setter* | set_discover_ipv6(value) | -+----------+--------------------------+ -| *Getter* | is_discover_ipv6() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_discover_ipv6(value) | ++-----------+--------------------------+ +| *Getter* | is_discover_ipv6() | ++-----------+--------------------------+ If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. @@ -216,11 +218,13 @@ If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. - :ref:`int` **discover_local_port** -+----------+--------------------------------+ -| *Setter* | set_discover_local_port(value) | -+----------+--------------------------------+ -| *Getter* | get_discover_local_port() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0 | ++-----------+--------------------------------+ +| *Setter* | set_discover_local_port(value) | ++-----------+--------------------------------+ +| *Getter* | get_discover_local_port() | ++-----------+--------------------------------+ If ``0``, the local port to use for discovery is chosen automatically by the system. If ``1``, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port. @@ -228,11 +232,13 @@ If ``0``, the local port to use for discovery is chosen automatically by the sys - :ref:`String` **discover_multicast_if** -+----------+----------------------------------+ -| *Setter* | set_discover_multicast_if(value) | -+----------+----------------------------------+ -| *Getter* | get_discover_multicast_if() | -+----------+----------------------------------+ ++-----------+----------------------------------+ +| *Default* | "" | ++-----------+----------------------------------+ +| *Setter* | set_discover_multicast_if(value) | ++-----------+----------------------------------+ +| *Getter* | get_discover_multicast_if() | ++-----------+----------------------------------+ Multicast interface to use for discovery. Uses the default multicast interface if empty. diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 319d71694..3b650efe4 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -19,19 +19,19 @@ UPNP device. Properties ---------- -+---------------------------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`description_url` | -+---------------------------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`igd_control_url` | -+---------------------------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`igd_our_addr` | -+---------------------------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`igd_service_type` | -+---------------------------------------------+---------------------------------------------------------------------+ -| :ref:`IGDStatus` | :ref:`igd_status` | -+---------------------------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`service_type` | -+---------------------------------------------+---------------------------------------------------------------------+ ++---------------------------------------------+---------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`description_url` | "" | ++---------------------------------------------+---------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`igd_control_url` | "" | ++---------------------------------------------+---------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`igd_our_addr` | "" | ++---------------------------------------------+---------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`igd_service_type` | "" | ++---------------------------------------------+---------------------------------------------------------------------+----+ +| :ref:`IGDStatus` | :ref:`igd_status` | 9 | ++---------------------------------------------+---------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`service_type` | "" | ++---------------------------------------------+---------------------------------------------------------------------+----+ Methods ------- @@ -105,11 +105,13 @@ Property Descriptions - :ref:`String` **description_url** -+----------+----------------------------+ -| *Setter* | set_description_url(value) | -+----------+----------------------------+ -| *Getter* | get_description_url() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | "" | ++-----------+----------------------------+ +| *Setter* | set_description_url(value) | ++-----------+----------------------------+ +| *Getter* | get_description_url() | ++-----------+----------------------------+ URL to the device description. @@ -117,11 +119,13 @@ URL to the device description. - :ref:`String` **igd_control_url** -+----------+----------------------------+ -| *Setter* | set_igd_control_url(value) | -+----------+----------------------------+ -| *Getter* | get_igd_control_url() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | "" | ++-----------+----------------------------+ +| *Setter* | set_igd_control_url(value) | ++-----------+----------------------------+ +| *Getter* | get_igd_control_url() | ++-----------+----------------------------+ IDG control URL. @@ -129,11 +133,13 @@ IDG control URL. - :ref:`String` **igd_our_addr** -+----------+-------------------------+ -| *Setter* | set_igd_our_addr(value) | -+----------+-------------------------+ -| *Getter* | get_igd_our_addr() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | "" | ++-----------+-------------------------+ +| *Setter* | set_igd_our_addr(value) | ++-----------+-------------------------+ +| *Getter* | get_igd_our_addr() | ++-----------+-------------------------+ Address of the local machine in the network connecting it to this ``UPNPDevice``. @@ -141,11 +147,13 @@ Address of the local machine in the network connecting it to this ``UPNPDevice`` - :ref:`String` **igd_service_type** -+----------+-----------------------------+ -| *Setter* | set_igd_service_type(value) | -+----------+-----------------------------+ -| *Getter* | get_igd_service_type() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | "" | ++-----------+-----------------------------+ +| *Setter* | set_igd_service_type(value) | ++-----------+-----------------------------+ +| *Getter* | get_igd_service_type() | ++-----------+-----------------------------+ IGD service type. @@ -153,11 +161,13 @@ IGD service type. - :ref:`IGDStatus` **igd_status** -+----------+-----------------------+ -| *Setter* | set_igd_status(value) | -+----------+-----------------------+ -| *Getter* | get_igd_status() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 9 | ++-----------+-----------------------+ +| *Setter* | set_igd_status(value) | ++-----------+-----------------------+ +| *Getter* | get_igd_status() | ++-----------+-----------------------+ IGD status. See :ref:`IGDStatus`. @@ -165,11 +175,13 @@ IGD status. See :ref:`IGDStatus`. - :ref:`String` **service_type** -+----------+-------------------------+ -| *Setter* | set_service_type(value) | -+----------+-------------------------+ -| *Getter* | get_service_type() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | "" | ++-----------+-------------------------+ +| *Setter* | set_service_type(value) | ++-----------+-------------------------+ +| *Getter* | get_service_type() | ++-----------+-------------------------+ Service type. diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index f993263ee..7e3291e0d 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -19,9 +19,9 @@ Vertical box container. Theme Properties ---------------- -+-----------------------+------------+ -| :ref:`int` | separation | -+-----------------------+------------+ ++-----------------------+------------+---+ +| :ref:`int` | separation | 4 | ++-----------------------+------------+---+ Description ----------- diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index a8b60a001..42bfcbd1f 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -17,11 +17,11 @@ Vector used for 2D math. Properties ---------- -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`x` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`y` | -+---------------------------+------------------------------------+ ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`x` | 0.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`y` | 0.0 | ++---------------------------+------------------------------------+-----+ Methods ------- @@ -136,12 +136,20 @@ Property Descriptions - :ref:`float` **x** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The vector's X component. Also accessible by using the index position ``[0]``. .. _class_Vector2_property_y: - :ref:`float` **y** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The vector's Y component. Also accessible by using the index position ``[1]``. Method Descriptions diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index bf2466ab5..9858f96a0 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -17,13 +17,13 @@ Vector class, which performs basic 3D vector math operations. Properties ---------- -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`x` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`y` | -+---------------------------+------------------------------------+ -| :ref:`float` | :ref:`z` | -+---------------------------+------------------------------------+ ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`x` | 0.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`y` | 0.0 | ++---------------------------+------------------------------------+-----+ +| :ref:`float` | :ref:`z` | 0.0 | ++---------------------------+------------------------------------+-----+ Methods ------- @@ -158,18 +158,30 @@ Property Descriptions - :ref:`float` **x** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The vector's X component. Also accessible by using the index position ``[0]``. .. _class_Vector3_property_y: - :ref:`float` **y** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The vector's Y component. Also accessible by using the index position ``[1]``. .. _class_Vector3_property_z: - :ref:`float` **z** ++-----------+-----+ +| *Default* | 0.0 | ++-----------+-----+ + The vector's Z component. Also accessible by using the index position ``[2]``. Method Descriptions diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 6d18d866a..b64a2c746 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -19,13 +19,13 @@ Physics body that simulates the behavior of a car. Properties ---------- -+---------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`brake` | -+---------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`engine_force` | -+---------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`steering` | -+---------------------------+--------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`brake` | 0.0 | ++---------------------------+--------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`engine_force` | 0.0 | ++---------------------------+--------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`steering` | 0.0 | ++---------------------------+--------------------------------------------------------------+-----+ Description ----------- @@ -41,11 +41,13 @@ Property Descriptions - :ref:`float` **brake** -+----------+------------------+ -| *Setter* | set_brake(value) | -+----------+------------------+ -| *Getter* | get_brake() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0.0 | ++-----------+------------------+ +| *Setter* | set_brake(value) | ++-----------+------------------+ +| *Getter* | get_brake() | ++-----------+------------------+ Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the :ref:`RigidBody.mass` of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. @@ -53,11 +55,13 @@ Slows down the vehicle by applying a braking force. The vehicle is only slowed d - :ref:`float` **engine_force** -+----------+-------------------------+ -| *Setter* | set_engine_force(value) | -+----------+-------------------------+ -| *Getter* | get_engine_force() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0.0 | ++-----------+-------------------------+ +| *Setter* | set_engine_force(value) | ++-----------+-------------------------+ +| *Getter* | get_engine_force() | ++-----------+-------------------------+ Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have :ref:`VehicleWheel.use_as_traction` set to ``true`` and are in contact with a surface. The :ref:`RigidBody.mass` of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. @@ -69,11 +73,13 @@ A negative value will result in the vehicle reversing. - :ref:`float` **steering** -+----------+---------------------+ -| *Setter* | set_steering(value) | -+----------+---------------------+ -| *Getter* | get_steering() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_steering(value) | ++-----------+---------------------+ +| *Getter* | get_steering() | ++-----------+---------------------+ The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have :ref:`VehicleWheel.use_as_steering` set to ``true`` will automatically be rotated. diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 718f2389f..280b8cc20 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -19,29 +19,29 @@ Physics object that simulates the behavior of a wheel. Properties ---------- -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_compression` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_relaxation` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`suspension_max_force` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`suspension_stiffness` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`suspension_travel` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_as_steering` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_as_traction` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`wheel_friction_slip` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`wheel_radius` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`wheel_rest_length` | -+---------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`wheel_roll_influence` | -+---------------------------+-------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`damping_compression` | 0.83 | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`damping_relaxation` | 0.88 | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`suspension_max_force` | 6000.0 | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`suspension_stiffness` | 5.88 | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`suspension_travel` | 5.0 | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`bool` | :ref:`use_as_steering` | false | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`bool` | :ref:`use_as_traction` | false | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`wheel_friction_slip` | 10.5 | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`wheel_radius` | 0.5 | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`wheel_rest_length` | 0.15 | ++---------------------------+-------------------------------------------------------------------------------+--------+ +| :ref:`float` | :ref:`wheel_roll_influence` | 0.1 | ++---------------------------+-------------------------------------------------------------------------------+--------+ Methods ------- @@ -66,11 +66,13 @@ Property Descriptions - :ref:`float` **damping_compression** -+----------+--------------------------------+ -| *Setter* | set_damping_compression(value) | -+----------+--------------------------------+ -| *Getter* | get_damping_compression() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | 0.83 | ++-----------+--------------------------------+ +| *Setter* | set_damping_compression(value) | ++-----------+--------------------------------+ +| *Getter* | get_damping_compression() | ++-----------+--------------------------------+ The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. @@ -78,11 +80,13 @@ The damping applied to the spring when the spring is being compressed. This valu - :ref:`float` **damping_relaxation** -+----------+-------------------------------+ -| *Setter* | set_damping_relaxation(value) | -+----------+-------------------------------+ -| *Getter* | get_damping_relaxation() | -+----------+-------------------------------+ ++-----------+-------------------------------+ +| *Default* | 0.88 | ++-----------+-------------------------------+ +| *Setter* | set_damping_relaxation(value) | ++-----------+-------------------------------+ +| *Getter* | get_damping_relaxation() | ++-----------+-------------------------------+ The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the :ref:`damping_compression` property. For a :ref:`damping_compression` value of 0.3, try a relaxation value of 0.5. @@ -90,11 +94,13 @@ The damping applied to the spring when relaxing. This value should be between 0. - :ref:`float` **suspension_max_force** -+----------+---------------------------------+ -| *Setter* | set_suspension_max_force(value) | -+----------+---------------------------------+ -| *Getter* | get_suspension_max_force() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 6000.0 | ++-----------+---------------------------------+ +| *Setter* | set_suspension_max_force(value) | ++-----------+---------------------------------+ +| *Getter* | get_suspension_max_force() | ++-----------+---------------------------------+ The maximum force the spring can resist. This value should be higher than a quarter of the :ref:`RigidBody.mass` of the :ref:`VehicleBody` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3× to 4× this number. @@ -102,11 +108,13 @@ The maximum force the spring can resist. This value should be higher than a quar - :ref:`float` **suspension_stiffness** -+----------+---------------------------------+ -| *Setter* | set_suspension_stiffness(value) | -+----------+---------------------------------+ -| *Getter* | get_suspension_stiffness() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | 5.88 | ++-----------+---------------------------------+ +| *Setter* | set_suspension_stiffness(value) | ++-----------+---------------------------------+ +| *Getter* | get_suspension_stiffness() | ++-----------+---------------------------------+ This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. @@ -114,11 +122,13 @@ This value defines the stiffness of the suspension. Use a value lower than 50 fo - :ref:`float` **suspension_travel** -+----------+------------------------------+ -| *Setter* | set_suspension_travel(value) | -+----------+------------------------------+ -| *Getter* | get_suspension_travel() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | 5.0 | ++-----------+------------------------------+ +| *Setter* | set_suspension_travel(value) | ++-----------+------------------------------+ +| *Getter* | get_suspension_travel() | ++-----------+------------------------------+ This is the distance the suspension can travel. As Godot units are equivalent to meters, keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car. @@ -126,11 +136,13 @@ This is the distance the suspension can travel. As Godot units are equivalent to - :ref:`bool` **use_as_steering** -+----------+----------------------------+ -| *Setter* | set_use_as_steering(value) | -+----------+----------------------------+ -| *Getter* | is_used_as_steering() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | false | ++-----------+----------------------------+ +| *Setter* | set_use_as_steering(value) | ++-----------+----------------------------+ +| *Getter* | is_used_as_steering() | ++-----------+----------------------------+ If ``true``, this wheel will be turned when the car steers. @@ -138,11 +150,13 @@ If ``true``, this wheel will be turned when the car steers. - :ref:`bool` **use_as_traction** -+----------+----------------------------+ -| *Setter* | set_use_as_traction(value) | -+----------+----------------------------+ -| *Getter* | is_used_as_traction() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | false | ++-----------+----------------------------+ +| *Setter* | set_use_as_traction(value) | ++-----------+----------------------------+ +| *Getter* | is_used_as_traction() | ++-----------+----------------------------+ If ``true``, this wheel transfers engine force to the ground to propel the vehicle forward. @@ -150,11 +164,13 @@ If ``true``, this wheel transfers engine force to the ground to propel the vehic - :ref:`float` **wheel_friction_slip** -+----------+--------------------------+ -| *Setter* | set_friction_slip(value) | -+----------+--------------------------+ -| *Getter* | get_friction_slip() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 10.5 | ++-----------+--------------------------+ +| *Setter* | set_friction_slip(value) | ++-----------+--------------------------+ +| *Getter* | get_friction_slip() | ++-----------+--------------------------+ This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. @@ -164,11 +180,13 @@ It's best to set this to 1.0 when starting out. - :ref:`float` **wheel_radius** -+----------+-------------------+ -| *Setter* | set_radius(value) | -+----------+-------------------+ -| *Getter* | get_radius() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0.5 | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ The radius of the wheel in meters. @@ -176,11 +194,13 @@ The radius of the wheel in meters. - :ref:`float` **wheel_rest_length** -+----------+-----------------------------------+ -| *Setter* | set_suspension_rest_length(value) | -+----------+-----------------------------------+ -| *Getter* | get_suspension_rest_length() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | 0.15 | ++-----------+-----------------------------------+ +| *Setter* | set_suspension_rest_length(value) | ++-----------+-----------------------------------+ +| *Getter* | get_suspension_rest_length() | ++-----------+-----------------------------------+ This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest. @@ -188,11 +208,13 @@ This is the distance in meters the wheel is lowered from its origin point. Don't - :ref:`float` **wheel_roll_influence** -+----------+---------------------------+ -| *Setter* | set_roll_influence(value) | -+----------+---------------------------+ -| *Getter* | get_roll_influence() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 0.1 | ++-----------+---------------------------+ +| *Setter* | set_roll_influence(value) | ++-----------+---------------------------+ +| *Getter* | get_roll_influence() | ++-----------+---------------------------+ This value affects the roll of your vehicle. If set to 0.0 for all wheels, your vehicle will be prone to rolling over, while a value of 1.0 will resist body roll. diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 3611edd6e..517e14440 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -19,27 +19,27 @@ Control for playing video streams. Properties ---------- -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio_track` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`autoplay` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`buffering_msec` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`bus` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`expand` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`paused` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`VideoStream` | :ref:`stream` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`stream_position` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`volume` | -+---------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`volume_db` | -+---------------------------------------+--------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`audio_track` | 0 | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`autoplay` | false | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`buffering_msec` | 500 | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`bus` | "Master" | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`expand` | true | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`paused` | false | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`VideoStream` | :ref:`stream` | null | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`stream_position` | | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`volume` | | ++---------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`volume_db` | 0.0 | ++---------------------------------------+--------------------------------------------------------------------+----------+ Methods ------- @@ -77,11 +77,13 @@ Property Descriptions - :ref:`int` **audio_track** -+----------+------------------------+ -| *Setter* | set_audio_track(value) | -+----------+------------------------+ -| *Getter* | get_audio_track() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_audio_track(value) | ++-----------+------------------------+ +| *Getter* | get_audio_track() | ++-----------+------------------------+ The embedded audio track to play. @@ -89,23 +91,27 @@ The embedded audio track to play. - :ref:`bool` **autoplay** -+----------+---------------------+ -| *Setter* | set_autoplay(value) | -+----------+---------------------+ -| *Getter* | has_autoplay() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_autoplay(value) | ++-----------+---------------------+ +| *Getter* | has_autoplay() | ++-----------+---------------------+ -If ``true``, playback starts when the scene loads. Default value: ``false``. +If ``true``, playback starts when the scene loads. .. _class_VideoPlayer_property_buffering_msec: - :ref:`int` **buffering_msec** -+----------+---------------------------+ -| *Setter* | set_buffering_msec(value) | -+----------+---------------------------+ -| *Getter* | get_buffering_msec() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 500 | ++-----------+---------------------------+ +| *Setter* | set_buffering_msec(value) | ++-----------+---------------------------+ +| *Getter* | get_buffering_msec() | ++-----------+---------------------------+ Amount of time in milliseconds to store in buffer while playing. @@ -113,11 +119,13 @@ Amount of time in milliseconds to store in buffer while playing. - :ref:`String` **bus** -+----------+----------------+ -| *Setter* | set_bus(value) | -+----------+----------------+ -| *Getter* | get_bus() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | "Master" | ++-----------+----------------+ +| *Setter* | set_bus(value) | ++-----------+----------------+ +| *Getter* | get_bus() | ++-----------+----------------+ Audio bus to use for sound playback. @@ -125,23 +133,27 @@ Audio bus to use for sound playback. - :ref:`bool` **expand** -+----------+-------------------+ -| *Setter* | set_expand(value) | -+----------+-------------------+ -| *Getter* | has_expand() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | true | ++-----------+-------------------+ +| *Setter* | set_expand(value) | ++-----------+-------------------+ +| *Getter* | has_expand() | ++-----------+-------------------+ -If ``true``, the video scales to the control size. Default value: ``true``. +If ``true``, the video scales to the control size. .. _class_VideoPlayer_property_paused: - :ref:`bool` **paused** -+----------+-------------------+ -| *Setter* | set_paused(value) | -+----------+-------------------+ -| *Getter* | is_paused() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | false | ++-----------+-------------------+ +| *Setter* | set_paused(value) | ++-----------+-------------------+ +| *Getter* | is_paused() | ++-----------+-------------------+ If ``true``, the video is paused. @@ -149,11 +161,13 @@ If ``true``, the video is paused. - :ref:`VideoStream` **stream** -+----------+-------------------+ -| *Setter* | set_stream(value) | -+----------+-------------------+ -| *Getter* | get_stream() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | null | ++-----------+-------------------+ +| *Setter* | set_stream(value) | ++-----------+-------------------+ +| *Getter* | get_stream() | ++-----------+-------------------+ .. _class_VideoPlayer_property_stream_position: @@ -183,11 +197,13 @@ Audio volume as a linear value. - :ref:`float` **volume_db** -+----------+----------------------+ -| *Setter* | set_volume_db(value) | -+----------+----------------------+ -| *Getter* | get_volume_db() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0.0 | ++-----------+----------------------+ +| *Setter* | set_volume_db(value) | ++-----------+----------------------+ +| *Getter* | get_volume_db() | ++-----------+----------------------+ Audio volume in dB. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 130890818..400a8ce26 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -19,65 +19,65 @@ Creates a sub-view into the screen. Properties ---------- -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`arvr` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio_listener_enable_2d` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio_listener_enable_3d` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`canvas_transform` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`DebugDraw` | :ref:`debug_draw` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disable_3d` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`global_canvas_transform` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_disable_input` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_snap_controls_to_pixels` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handle_input_locally` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hdr` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`keep_3d_linear` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`MSAA` | :ref:`msaa` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`own_world` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics_object_picking` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`render_direct_to_screen` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`ClearMode` | :ref:`render_target_clear_mode` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`UpdateMode` | :ref:`render_target_update_mode` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`render_target_v_flip` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_0` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_1` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_2` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_3` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_atlas_size` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transparent_bg` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Usage` | :ref:`usage` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`world` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`world_2d` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`arvr` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`audio_listener_enable_2d` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`audio_listener_enable_3d` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`Transform2D` | :ref:`canvas_transform` | | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`DebugDraw` | :ref:`debug_draw` | 0 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`disable_3d` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`Transform2D` | :ref:`global_canvas_transform` | | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`gui_disable_input` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`gui_snap_controls_to_pixels` | true | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`handle_input_locally` | true | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`hdr` | true | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`keep_3d_linear` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`MSAA` | :ref:`msaa` | 0 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`own_world` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`physics_object_picking` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`render_direct_to_screen` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`ClearMode` | :ref:`render_target_clear_mode` | 0 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`UpdateMode` | :ref:`render_target_update_mode` | 2 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`render_target_v_flip` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_0` | 2 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_1` | 2 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_2` | 3 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_3` | 4 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`int` | :ref:`shadow_atlas_size` | 0 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`size` | Vector2( 0, 0 ) | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`bool` | :ref:`transparent_bg` | false | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`Usage` | :ref:`usage` | 2 | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`World` | :ref:`world` | null | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ +| :ref:`World2D` | :ref:`world_2d` | | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------+ Methods ------- @@ -343,37 +343,43 @@ Property Descriptions - :ref:`bool` **arvr** -+----------+---------------------+ -| *Setter* | set_use_arvr(value) | -+----------+---------------------+ -| *Getter* | use_arvr() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_use_arvr(value) | ++-----------+---------------------+ +| *Getter* | use_arvr() | ++-----------+---------------------+ -If ``true``, the viewport will be used in AR/VR process. Default value: ``false``. +If ``true``, the viewport will be used in AR/VR process. .. _class_Viewport_property_audio_listener_enable_2d: - :ref:`bool` **audio_listener_enable_2d** -+----------+---------------------------------+ -| *Setter* | set_as_audio_listener_2d(value) | -+----------+---------------------------------+ -| *Getter* | is_audio_listener_2d() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | false | ++-----------+---------------------------------+ +| *Setter* | set_as_audio_listener_2d(value) | ++-----------+---------------------------------+ +| *Getter* | is_audio_listener_2d() | ++-----------+---------------------------------+ -If ``true``, the viewport will process 2D audio streams. Default value: ``false``. +If ``true``, the viewport will process 2D audio streams. .. _class_Viewport_property_audio_listener_enable_3d: - :ref:`bool` **audio_listener_enable_3d** -+----------+------------------------------+ -| *Setter* | set_as_audio_listener(value) | -+----------+------------------------------+ -| *Getter* | is_audio_listener() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | false | ++-----------+------------------------------+ +| *Setter* | set_as_audio_listener(value) | ++-----------+------------------------------+ +| *Getter* | is_audio_listener() | ++-----------+------------------------------+ -If ``true``, the viewport will process 3D audio streams. Default value: ``false``. +If ``true``, the viewport will process 3D audio streams. .. _class_Viewport_property_canvas_transform: @@ -391,25 +397,29 @@ The canvas transform of the viewport, useful for changing the on-screen position - :ref:`DebugDraw` **debug_draw** -+----------+-----------------------+ -| *Setter* | set_debug_draw(value) | -+----------+-----------------------+ -| *Getter* | get_debug_draw() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_debug_draw(value) | ++-----------+-----------------------+ +| *Getter* | get_debug_draw() | ++-----------+-----------------------+ -The overlay mode for test rendered geometry in debug purposes. Default value: :ref:`DEBUG_DRAW_DISABLED`. +The overlay mode for test rendered geometry in debug purposes. .. _class_Viewport_property_disable_3d: - :ref:`bool` **disable_3d** -+----------+-----------------------+ -| *Setter* | set_disable_3d(value) | -+----------+-----------------------+ -| *Getter* | is_3d_disabled() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | false | ++-----------+-----------------------+ +| *Setter* | set_disable_3d(value) | ++-----------+-----------------------+ +| *Getter* | is_3d_disabled() | ++-----------+-----------------------+ -If ``true``, the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. +If ``true``, the viewport will disable 3D rendering. For actual disabling use ``usage``. .. _class_Viewport_property_global_canvas_transform: @@ -427,57 +437,67 @@ The global canvas transform of the viewport. The canvas transform is relative to - :ref:`bool` **gui_disable_input** -+----------+--------------------------+ -| *Setter* | set_disable_input(value) | -+----------+--------------------------+ -| *Getter* | is_input_disabled() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_disable_input(value) | ++-----------+--------------------------+ +| *Getter* | is_input_disabled() | ++-----------+--------------------------+ -If ``true``, the viewport will not receive input event. Default value: ``false``. +If ``true``, the viewport will not receive input event. .. _class_Viewport_property_gui_snap_controls_to_pixels: - :ref:`bool` **gui_snap_controls_to_pixels** -+----------+--------------------------------------+ -| *Setter* | set_snap_controls_to_pixels(value) | -+----------+--------------------------------------+ -| *Getter* | is_snap_controls_to_pixels_enabled() | -+----------+--------------------------------------+ ++-----------+--------------------------------------+ +| *Default* | true | ++-----------+--------------------------------------+ +| *Setter* | set_snap_controls_to_pixels(value) | ++-----------+--------------------------------------+ +| *Getter* | is_snap_controls_to_pixels_enabled() | ++-----------+--------------------------------------+ -If ``true``, the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. +If ``true``, the GUI controls on the viewport will lay pixel perfectly. .. _class_Viewport_property_handle_input_locally: - :ref:`bool` **handle_input_locally** -+----------+---------------------------------+ -| *Setter* | set_handle_input_locally(value) | -+----------+---------------------------------+ -| *Getter* | is_handling_input_locally() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | true | ++-----------+---------------------------------+ +| *Setter* | set_handle_input_locally(value) | ++-----------+---------------------------------+ +| *Getter* | is_handling_input_locally() | ++-----------+---------------------------------+ .. _class_Viewport_property_hdr: - :ref:`bool` **hdr** -+----------+----------------+ -| *Setter* | set_hdr(value) | -+----------+----------------+ -| *Getter* | get_hdr() | -+----------+----------------+ ++-----------+----------------+ +| *Default* | true | ++-----------+----------------+ +| *Setter* | set_hdr(value) | ++-----------+----------------+ +| *Getter* | get_hdr() | ++-----------+----------------+ -If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. +If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm. .. _class_Viewport_property_keep_3d_linear: - :ref:`bool` **keep_3d_linear** -+----------+---------------------------+ -| *Setter* | set_keep_3d_linear(value) | -+----------+---------------------------+ -| *Getter* | get_keep_3d_linear() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | false | ++-----------+---------------------------+ +| *Setter* | set_keep_3d_linear(value) | ++-----------+---------------------------+ +| *Getter* | get_keep_3d_linear() | ++-----------+---------------------------+ If ``true``, the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. @@ -485,143 +505,167 @@ If ``true``, the result after 3D rendering will not have a linear to sRGB color - :ref:`MSAA` **msaa** -+----------+-----------------+ -| *Setter* | set_msaa(value) | -+----------+-----------------+ -| *Getter* | get_msaa() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_msaa(value) | ++-----------+-----------------+ +| *Getter* | get_msaa() | ++-----------+-----------------+ -The multisample anti-aliasing mode. Default value: :ref:`MSAA_DISABLED`. +The multisample anti-aliasing mode. .. _class_Viewport_property_own_world: - :ref:`bool` **own_world** -+----------+--------------------------+ -| *Setter* | set_use_own_world(value) | -+----------+--------------------------+ -| *Getter* | is_using_own_world() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | false | ++-----------+--------------------------+ +| *Setter* | set_use_own_world(value) | ++-----------+--------------------------+ +| *Getter* | is_using_own_world() | ++-----------+--------------------------+ -If ``true``, the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. +If ``true``, the viewport will use :ref:`World` defined in ``world`` property. .. _class_Viewport_property_physics_object_picking: - :ref:`bool` **physics_object_picking** -+----------+-----------------------------------+ -| *Setter* | set_physics_object_picking(value) | -+----------+-----------------------------------+ -| *Getter* | get_physics_object_picking() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | false | ++-----------+-----------------------------------+ +| *Setter* | set_physics_object_picking(value) | ++-----------+-----------------------------------+ +| *Getter* | get_physics_object_picking() | ++-----------+-----------------------------------+ -If ``true``, the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. +If ``true``, the objects rendered by viewport become subjects of mouse picking process. .. _class_Viewport_property_render_direct_to_screen: - :ref:`bool` **render_direct_to_screen** -+----------+----------------------------------------+ -| *Setter* | set_use_render_direct_to_screen(value) | -+----------+----------------------------------------+ -| *Getter* | is_using_render_direct_to_screen() | -+----------+----------------------------------------+ ++-----------+----------------------------------------+ +| *Default* | false | ++-----------+----------------------------------------+ +| *Setter* | set_use_render_direct_to_screen(value) | ++-----------+----------------------------------------+ +| *Getter* | is_using_render_direct_to_screen() | ++-----------+----------------------------------------+ -If ``true``, renders the Viewport directly to the screen instead of to the root viewport. Only available in GLES2. This is a low-level optimization and should not be used in most cases. If used, reading from the Viewport or from ``SCREEN_TEXTURE`` becomes unavailable. For more information see :ref:`VisualServer.viewport_set_render_direct_to_screen`. Default value: ``false``. +If ``true``, renders the Viewport directly to the screen instead of to the root viewport. Only available in GLES2. This is a low-level optimization and should not be used in most cases. If used, reading from the Viewport or from ``SCREEN_TEXTURE`` becomes unavailable. For more information see :ref:`VisualServer.viewport_set_render_direct_to_screen`. .. _class_Viewport_property_render_target_clear_mode: - :ref:`ClearMode` **render_target_clear_mode** -+----------+-----------------------+ -| *Setter* | set_clear_mode(value) | -+----------+-----------------------+ -| *Getter* | get_clear_mode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_clear_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_clear_mode() | ++-----------+-----------------------+ -The clear mode when viewport used as a render target. Default value: :ref:`CLEAR_MODE_ALWAYS`. +The clear mode when viewport used as a render target. .. _class_Viewport_property_render_target_update_mode: - :ref:`UpdateMode` **render_target_update_mode** -+----------+------------------------+ -| *Setter* | set_update_mode(value) | -+----------+------------------------+ -| *Getter* | get_update_mode() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 2 | ++-----------+------------------------+ +| *Setter* | set_update_mode(value) | ++-----------+------------------------+ +| *Getter* | get_update_mode() | ++-----------+------------------------+ -The update mode when viewport used as a render target. Default value: :ref:`UPDATE_WHEN_VISIBLE`. +The update mode when viewport used as a render target. .. _class_Viewport_property_render_target_v_flip: - :ref:`bool` **render_target_v_flip** -+----------+------------------+ -| *Setter* | set_vflip(value) | -+----------+------------------+ -| *Getter* | get_vflip() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | false | ++-----------+------------------+ +| *Setter* | set_vflip(value) | ++-----------+------------------+ +| *Getter* | get_vflip() | ++-----------+------------------+ -If ``true``, the result of rendering will be flipped vertically. Default value: ``false``. +If ``true``, the result of rendering will be flipped vertically. .. _class_Viewport_property_shadow_atlas_quad_0: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** -+----------+-----------------------------------------+ -| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | -+----------+-----------------------------------------+ -| *Getter* | get_shadow_atlas_quadrant_subdiv() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | 2 | ++-----------+-----------------------------------------+ +| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_shadow_atlas_quadrant_subdiv() | ++-----------+-----------------------------------------+ -The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. +The subdivision amount of first quadrant on shadow atlas. .. _class_Viewport_property_shadow_atlas_quad_1: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** -+----------+-----------------------------------------+ -| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | -+----------+-----------------------------------------+ -| *Getter* | get_shadow_atlas_quadrant_subdiv() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | 2 | ++-----------+-----------------------------------------+ +| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_shadow_atlas_quadrant_subdiv() | ++-----------+-----------------------------------------+ -The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. +The subdivision amount of second quadrant on shadow atlas. .. _class_Viewport_property_shadow_atlas_quad_2: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** -+----------+-----------------------------------------+ -| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | -+----------+-----------------------------------------+ -| *Getter* | get_shadow_atlas_quadrant_subdiv() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | 3 | ++-----------+-----------------------------------------+ +| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_shadow_atlas_quadrant_subdiv() | ++-----------+-----------------------------------------+ -The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. +The subdivision amount of third quadrant on shadow atlas. .. _class_Viewport_property_shadow_atlas_quad_3: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** -+----------+-----------------------------------------+ -| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | -+----------+-----------------------------------------+ -| *Getter* | get_shadow_atlas_quadrant_subdiv() | -+----------+-----------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | 4 | ++-----------+-----------------------------------------+ +| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | ++-----------+-----------------------------------------+ +| *Getter* | get_shadow_atlas_quadrant_subdiv() | ++-----------+-----------------------------------------+ -The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. +The subdivision amount of fourth quadrant on shadow atlas. .. _class_Viewport_property_shadow_atlas_size: - :ref:`int` **shadow_atlas_size** -+----------+------------------------------+ -| *Setter* | set_shadow_atlas_size(value) | -+----------+------------------------------+ -| *Getter* | get_shadow_atlas_size() | -+----------+------------------------------+ ++-----------+------------------------------+ +| *Default* | 0 | ++-----------+------------------------------+ +| *Setter* | set_shadow_atlas_size(value) | ++-----------+------------------------------+ +| *Getter* | get_shadow_atlas_size() | ++-----------+------------------------------+ The resolution of shadow atlas. Both width and height is equal to one value. @@ -629,11 +673,13 @@ The resolution of shadow atlas. Both width and height is equal to one value. - :ref:`Vector2` **size** -+----------+-----------------+ -| *Setter* | set_size(value) | -+----------+-----------------+ -| *Getter* | get_size() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | Vector2( 0, 0 ) | ++-----------+-----------------+ +| *Setter* | set_size(value) | ++-----------+-----------------+ +| *Getter* | get_size() | ++-----------+-----------------+ The width and height of viewport. @@ -641,35 +687,41 @@ The width and height of viewport. - :ref:`bool` **transparent_bg** -+----------+-----------------------------------+ -| *Setter* | set_transparent_background(value) | -+----------+-----------------------------------+ -| *Getter* | has_transparent_background() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | false | ++-----------+-----------------------------------+ +| *Setter* | set_transparent_background(value) | ++-----------+-----------------------------------+ +| *Getter* | has_transparent_background() | ++-----------+-----------------------------------+ -If ``true``, the viewport should render its background as transparent. Default value: ``false``. +If ``true``, the viewport should render its background as transparent. .. _class_Viewport_property_usage: - :ref:`Usage` **usage** -+----------+------------------+ -| *Setter* | set_usage(value) | -+----------+------------------+ -| *Getter* | get_usage() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 2 | ++-----------+------------------+ +| *Setter* | set_usage(value) | ++-----------+------------------+ +| *Getter* | get_usage() | ++-----------+------------------+ -The rendering mode of viewport. Default value: ``USAGE_3D``. +The rendering mode of viewport. .. _class_Viewport_property_world: - :ref:`World` **world** -+----------+------------------+ -| *Setter* | set_world(value) | -+----------+------------------+ -| *Getter* | get_world() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | null | ++-----------+------------------+ +| *Setter* | set_world(value) | ++-----------+------------------+ +| *Getter* | get_world() | ++-----------+------------------+ The custom :ref:`World` which can be used as 3D environment source. diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index e722e3e81..04a1a04fd 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -19,11 +19,11 @@ Control for holding :ref:`Viewport`\ s. Properties ---------- -+-------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stretch` | -+-------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_shrink` | -+-------------------------+------------------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`stretch` | false | ++-------------------------+------------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`stretch_shrink` | 1 | ++-------------------------+------------------------------------------------------------------------+-------+ Description ----------- @@ -37,21 +37,25 @@ Property Descriptions - :ref:`bool` **stretch** -+----------+----------------------+ -| *Setter* | set_stretch(value) | -+----------+----------------------+ -| *Getter* | is_stretch_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_stretch(value) | ++-----------+----------------------+ +| *Getter* | is_stretch_enabled() | ++-----------+----------------------+ -If ``true``, the viewport will be scaled to the control's size. Default value: ``false``. +If ``true``, the viewport will be scaled to the control's size. .. _class_ViewportContainer_property_stretch_shrink: - :ref:`int` **stretch_shrink** -+----------+---------------------------+ -| *Setter* | set_stretch_shrink(value) | -+----------+---------------------------+ -| *Getter* | get_stretch_shrink() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | 1 | ++-----------+---------------------------+ +| *Setter* | set_stretch_shrink(value) | ++-----------+---------------------------+ +| *Getter* | get_stretch_shrink() | ++-----------+---------------------------+ diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 0e81b3a0b..47606c37b 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -19,9 +19,9 @@ Texture which displays the content of a :ref:`Viewport`. Properties ---------- -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`viewport_path` | -+---------------------------------+--------------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------------+--------------+ +| :ref:`NodePath` | :ref:`viewport_path` | NodePath("") | ++---------------------------------+--------------------------------------------------------------------+--------------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`NodePath` **viewport_path** -+----------+-----------------------------------+ -| *Setter* | set_viewport_path_in_scene(value) | -+----------+-----------------------------------+ -| *Getter* | get_viewport_path_in_scene() | -+----------+-----------------------------------+ ++-----------+-----------------------------------+ +| *Default* | NodePath("") | ++-----------+-----------------------------------+ +| *Setter* | set_viewport_path_in_scene(value) | ++-----------+-----------------------------------+ +| *Getter* | get_viewport_path_in_scene() | ++-----------+-----------------------------------+ The path to the :ref:`Viewport` node to display. This is relative to the scene root, not to the node which uses the texture. diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index fb16972ed..66b579000 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -19,11 +19,11 @@ Enables certain nodes only when visible. Properties ---------- -+-------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`freeze_bodies` | -+-------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pause_animations` | -+-------------------------+----------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`freeze_bodies` | true | ++-------------------------+----------------------------------------------------------------------------+------+ +| :ref:`bool` | :ref:`pause_animations` | true | ++-------------------------+----------------------------------------------------------------------------+------+ Enumerations ------------ @@ -56,11 +56,13 @@ Property Descriptions - :ref:`bool` **freeze_bodies** -+----------+----------------------+ -| *Setter* | set_enabler(value) | -+----------+----------------------+ -| *Getter* | is_enabler_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_enabler(value) | ++-----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++-----------+----------------------+ If ``true``, :ref:`RigidBody` nodes will be paused. @@ -68,11 +70,13 @@ If ``true``, :ref:`RigidBody` nodes will be paused. - :ref:`bool` **pause_animations** -+----------+----------------------+ -| *Setter* | set_enabler(value) | -+----------+----------------------+ -| *Getter* | is_enabler_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_enabler(value) | ++-----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++-----------+----------------------+ If ``true``, :ref:`AnimationPlayer` nodes will be paused. diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 570c3d1ca..14c338199 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -19,19 +19,19 @@ Enables certain nodes only when visible. Properties ---------- -+-------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`freeze_bodies` | -+-------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pause_animated_sprites` | -+-------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pause_animations` | -+-------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pause_particles` | -+-------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics_process_parent` | -+-------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`process_parent` | -+-------------------------+------------------------------------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`freeze_bodies` | true | ++-------------------------+------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`pause_animated_sprites` | true | ++-------------------------+------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`pause_animations` | true | ++-------------------------+------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`pause_particles` | true | ++-------------------------+------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`physics_process_parent` | false | ++-------------------------+------------------------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`process_parent` | false | ++-------------------------+------------------------------------------------------------------------------------------+-------+ Enumerations ------------ @@ -80,11 +80,13 @@ Property Descriptions - :ref:`bool` **freeze_bodies** -+----------+----------------------+ -| *Setter* | set_enabler(value) | -+----------+----------------------+ -| *Getter* | is_enabler_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_enabler(value) | ++-----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++-----------+----------------------+ If ``true``, :ref:`RigidBody2D` nodes will be paused. @@ -92,11 +94,13 @@ If ``true``, :ref:`RigidBody2D` nodes will be paused. - :ref:`bool` **pause_animated_sprites** -+----------+----------------------+ -| *Setter* | set_enabler(value) | -+----------+----------------------+ -| *Getter* | is_enabler_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_enabler(value) | ++-----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++-----------+----------------------+ If ``true``, :ref:`AnimatedSprite` nodes will be paused. @@ -104,11 +108,13 @@ If ``true``, :ref:`AnimatedSprite` nodes will be paused. - :ref:`bool` **pause_animations** -+----------+----------------------+ -| *Setter* | set_enabler(value) | -+----------+----------------------+ -| *Getter* | is_enabler_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_enabler(value) | ++-----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++-----------+----------------------+ If ``true``, :ref:`AnimationPlayer` nodes will be paused. @@ -116,11 +122,13 @@ If ``true``, :ref:`AnimationPlayer` nodes will be paused. - :ref:`bool` **pause_particles** -+----------+----------------------+ -| *Setter* | set_enabler(value) | -+----------+----------------------+ -| *Getter* | is_enabler_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | true | ++-----------+----------------------+ +| *Setter* | set_enabler(value) | ++-----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++-----------+----------------------+ If ``true``, :ref:`Particles2D` nodes will be paused. @@ -128,11 +136,13 @@ If ``true``, :ref:`Particles2D` nodes will be paused. - :ref:`bool` **physics_process_parent** -+----------+----------------------+ -| *Setter* | set_enabler(value) | -+----------+----------------------+ -| *Getter* | is_enabler_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_enabler(value) | ++-----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++-----------+----------------------+ If ``true``, the parent's :ref:`Node._physics_process` will be stopped. @@ -140,11 +150,13 @@ If ``true``, the parent's :ref:`Node._physics_process` **process_parent** -+----------+----------------------+ -| *Setter* | set_enabler(value) | -+----------+----------------------+ -| *Getter* | is_enabler_enabled() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_enabler(value) | ++-----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++-----------+----------------------+ If ``true``, the parent's :ref:`Node._process` will be stopped. diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index f22dbdfcf..d50724552 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -21,9 +21,9 @@ Detects when the node is visible on screen. Properties ---------- -+-------------------------+-----------------------------------------------------+ -| :ref:`AABB` | :ref:`aabb` | -+-------------------------+-----------------------------------------------------+ ++-------------------------+-----------------------------------------------------+-----------------------------+ +| :ref:`AABB` | :ref:`aabb` | AABB( -1, -1, -1, 2, 2, 2 ) | ++-------------------------+-----------------------------------------------------+-----------------------------+ Methods ------- @@ -71,11 +71,13 @@ Property Descriptions - :ref:`AABB` **aabb** -+----------+-----------------+ -| *Setter* | set_aabb(value) | -+----------+-----------------+ -| *Getter* | get_aabb() | -+----------+-----------------+ ++-----------+-----------------------------+ +| *Default* | AABB( -1, -1, -1, 2, 2, 2 ) | ++-----------+-----------------------------+ +| *Setter* | set_aabb(value) | ++-----------+-----------------------------+ +| *Getter* | get_aabb() | ++-----------+-----------------------------+ The VisibilityNotifier's bounding box. diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 8d7615e50..13edc27a1 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -21,9 +21,9 @@ Detects when the node is visible on screen. Properties ---------- -+---------------------------+-------------------------------------------------------+ -| :ref:`Rect2` | :ref:`rect` | -+---------------------------+-------------------------------------------------------+ ++---------------------------+-------------------------------------------------------+---------------------------+ +| :ref:`Rect2` | :ref:`rect` | Rect2( -10, -10, 20, 20 ) | ++---------------------------+-------------------------------------------------------+---------------------------+ Methods ------- @@ -71,11 +71,13 @@ Property Descriptions - :ref:`Rect2` **rect** -+----------+-----------------+ -| *Setter* | set_rect(value) | -+----------+-----------------+ -| *Getter* | get_rect() | -+----------+-----------------+ ++-----------+---------------------------+ +| *Default* | Rect2( -10, -10, 20, 20 ) | ++-----------+---------------------------+ +| *Setter* | set_rect(value) | ++-----------+---------------------------+ +| *Getter* | get_rect() | ++-----------+---------------------------+ The VisibilityNotifier2D's bounding rectangle. diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 9c9331b16..c173af097 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -21,9 +21,9 @@ Brief Description Properties ---------- -+-----------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`layers` | -+-----------------------+-----------------------------------------------------+ ++-----------------------+-----------------------------------------------------+---+ +| :ref:`int` | :ref:`layers` | 1 | ++-----------------------+-----------------------------------------------------+---+ Methods ------- @@ -51,11 +51,13 @@ Property Descriptions - :ref:`int` **layers** -+----------+-----------------------+ -| *Setter* | set_layer_mask(value) | -+----------+-----------------------+ -| *Getter* | get_layer_mask() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1 | ++-----------+-----------------------+ +| *Setter* | set_layer_mask(value) | ++-----------+-----------------------+ +| *Getter* | get_layer_mask() | ++-----------+-----------------------+ The render layer(s) this VisualInstance is drawn on. diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 9ee425bc2..09b4f53c5 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -19,11 +19,11 @@ A Visual Script node representing a constant from the base types. Properties ---------- -+-----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | -+-----------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`constant` | -+-----------------------------------------------------+----------------------------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------+---+ +| :ref:`Variant.Type` | :ref:`basic_type` | 0 | ++-----------------------------------------------------+----------------------------------------------------------------------------+---+ +| :ref:`String` | :ref:`constant` | | ++-----------------------------------------------------+----------------------------------------------------------------------------+---+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`Variant.Type` **basic_type** -+----------+-----------------------+ -| *Setter* | set_basic_type(value) | -+----------+-----------------------+ -| *Getter* | get_basic_type() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 0 | ++-----------+-----------------------+ +| *Setter* | set_basic_type(value) | ++-----------+-----------------------+ +| *Getter* | get_basic_type() | ++-----------+-----------------------+ The type to get the constant from. diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 258dcea92..d9212dec2 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -19,9 +19,9 @@ A Visual Script node used to call built-in functions. Properties ---------- -+--------------------------------------------------------------+------------------------------------------------------------------+ -| :ref:`BuiltinFunc` | :ref:`function` | -+--------------------------------------------------------------+------------------------------------------------------------------+ ++--------------------------------------------------------------+------------------------------------------------------------------+---+ +| :ref:`BuiltinFunc` | :ref:`function` | 0 | ++--------------------------------------------------------------+------------------------------------------------------------------+---+ Enumerations ------------ @@ -315,11 +315,13 @@ Property Descriptions - :ref:`BuiltinFunc` **function** -+----------+-----------------+ -| *Setter* | set_func(value) | -+----------+-----------------+ -| *Getter* | get_func() | -+----------+-----------------+ ++-----------+-----------------+ +| *Default* | 0 | ++-----------+-----------------+ +| *Setter* | set_func(value) | ++-----------+-----------------+ +| *Getter* | get_func() | ++-----------+-----------------+ The function to be executed. diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index fc4c5454d..cf6fb1ca9 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -19,11 +19,11 @@ Gets a constant from a given class. Properties ---------- -+-----------------------------+----------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+-----------------------------+----------------------------------------------------------------------+ -| :ref:`String` | :ref:`constant` | -+-----------------------------+----------------------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_type` | "Object" | ++-----------------------------+----------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`constant` | "" | ++-----------------------------+----------------------------------------------------------------------+----------+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`String` **base_type** -+----------+----------------------+ -| *Setter* | set_base_type(value) | -+----------+----------------------+ -| *Getter* | get_base_type() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "Object" | ++-----------+----------------------+ +| *Setter* | set_base_type(value) | ++-----------+----------------------+ +| *Getter* | get_base_type() | ++-----------+----------------------+ The constant's parent class. @@ -57,11 +59,13 @@ The constant's parent class. - :ref:`String` **constant** -+----------+---------------------------+ -| *Setter* | set_class_constant(value) | -+----------+---------------------------+ -| *Getter* | get_class_constant() | -+----------+---------------------------+ ++-----------+---------------------------+ +| *Default* | "" | ++-----------+---------------------------+ +| *Setter* | set_class_constant(value) | ++-----------+---------------------------+ +| *Getter* | get_class_constant() | ++-----------+---------------------------+ The constant to return. See the given class for its available constants. diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index 8f3dc9f8a..3d3beb745 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -19,13 +19,13 @@ A Visual Script node used to annotate the script. Properties ---------- -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`description` | -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`title` | -+-------------------------------+--------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`description` | "" | ++-------------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`size` | Vector2( 150, 150 ) | ++-------------------------------+--------------------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`title` | "Comment" | ++-------------------------------+--------------------------------------------------------------------+---------------------+ Description ----------- @@ -41,11 +41,13 @@ Property Descriptions - :ref:`String` **description** -+----------+------------------------+ -| *Setter* | set_description(value) | -+----------+------------------------+ -| *Getter* | get_description() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | "" | ++-----------+------------------------+ +| *Setter* | set_description(value) | ++-----------+------------------------+ +| *Getter* | get_description() | ++-----------+------------------------+ The text inside the comment node. @@ -53,11 +55,13 @@ The text inside the comment node. - :ref:`Vector2` **size** -+----------+-----------------+ -| *Setter* | set_size(value) | -+----------+-----------------+ -| *Getter* | get_size() | -+----------+-----------------+ ++-----------+---------------------+ +| *Default* | Vector2( 150, 150 ) | ++-----------+---------------------+ +| *Setter* | set_size(value) | ++-----------+---------------------+ +| *Getter* | get_size() | ++-----------+---------------------+ The comment node's size (in pixels). @@ -65,11 +69,13 @@ The comment node's size (in pixels). - :ref:`String` **title** -+----------+------------------+ -| *Setter* | set_title(value) | -+----------+------------------+ -| *Getter* | get_title() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | "Comment" | ++-----------+------------------+ +| *Setter* | set_title(value) | ++-----------+------------------+ +| *Getter* | get_title() | ++-----------+------------------+ The comment node's title. diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 4a964eab1..6d5a02e96 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -19,11 +19,11 @@ Gets a contant's value. Properties ---------- -+-----------------------------------------------------+---------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+---------------------------------------------------------+ -| :ref:`Variant` | :ref:`value` | -+-----------------------------------------------------+---------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------+---+ +| :ref:`Variant.Type` | :ref:`type` | 0 | ++-----------------------------------------------------+---------------------------------------------------------+---+ +| :ref:`Variant` | :ref:`value` | | ++-----------------------------------------------------+---------------------------------------------------------+---+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`Variant.Type` **type** -+----------+--------------------------+ -| *Setter* | set_constant_type(value) | -+----------+--------------------------+ -| *Getter* | get_constant_type() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_constant_type(value) | ++-----------+--------------------------+ +| *Getter* | get_constant_type() | ++-----------+--------------------------+ The constant's type. diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index 412f5a808..b76e41e9f 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -19,9 +19,9 @@ A Visual Script node which deconstructs a base type instance into its parts. Properties ---------- -+-----------------------------------------------------+----------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+----------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------+---+ +| :ref:`Variant.Type` | :ref:`type` | 0 | ++-----------------------------------------------------+----------------------------------------------------------+---+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`Variant.Type` **type** -+----------+-----------------------------+ -| *Setter* | set_deconstruct_type(value) | -+----------+-----------------------------+ -| *Getter* | get_deconstruct_type() | -+----------+-----------------------------+ ++-----------+-----------------------------+ +| *Default* | 0 | ++-----------+-----------------------------+ +| *Setter* | set_deconstruct_type(value) | ++-----------+-----------------------------+ +| *Getter* | get_deconstruct_type() | ++-----------+-----------------------------+ The type to deconstruct. diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 60f97aeb5..6131fde63 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -19,9 +19,9 @@ Emits a specified signal. Properties ---------- -+-----------------------------+-------------------------------------------------------------+ -| :ref:`String` | :ref:`signal` | -+-----------------------------+-------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------+----+ +| :ref:`String` | :ref:`signal` | "" | ++-----------------------------+-------------------------------------------------------------+----+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`String` **signal** -+----------+-------------------+ -| *Setter* | set_signal(value) | -+----------+-------------------+ -| *Getter* | get_signal() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | "" | ++-----------+-------------------+ +| *Setter* | set_signal(value) | ++-----------+-------------------+ +| *Getter* | get_signal() | ++-----------+-------------------+ The signal to emit. diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 2dd05d343..2d97fbe04 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -19,9 +19,9 @@ A Visual Script node returning a singleton from :ref:`@GlobalScope` | :ref:`constant` | -+-----------------------------+----------------------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`constant` | "" | ++-----------------------------+----------------------------------------------------------------------+----+ Description ----------- @@ -35,11 +35,13 @@ Property Descriptions - :ref:`String` **constant** -+----------+----------------------+ -| *Setter* | set_singleton(value) | -+----------+----------------------+ -| *Getter* | get_singleton() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "" | ++-----------+----------------------+ +| *Setter* | set_singleton(value) | ++-----------+----------------------+ +| *Getter* | get_singleton() | ++-----------+----------------------+ The singleton's name. diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 38b4ea468..fb8ba7086 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -19,27 +19,27 @@ Brief Description Properties ---------- -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_script` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`CallMode` | :ref:`call_mode` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`function` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`RPCCallMode` | :ref:`rpc_call_mode` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`singleton` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`use_default_args` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`validate` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+ ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_script` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_type` | "Object" | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`Variant.Type` | :ref:`basic_type` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`CallMode` | :ref:`call_mode` | 0 | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`function` | "" | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`NodePath` | :ref:`node_path` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`RPCCallMode` | :ref:`rpc_call_mode` | 0 | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`singleton` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`use_default_args` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`validate` | true | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+ Enumerations ------------ @@ -109,11 +109,13 @@ Property Descriptions - :ref:`String` **base_type** -+----------+----------------------+ -| *Setter* | set_base_type(value) | -+----------+----------------------+ -| *Getter* | get_base_type() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "Object" | ++-----------+----------------------+ +| *Setter* | set_base_type(value) | ++-----------+----------------------+ +| *Getter* | get_base_type() | ++-----------+----------------------+ .. _class_VisualScriptFunctionCall_property_basic_type: @@ -129,21 +131,25 @@ Property Descriptions - :ref:`CallMode` **call_mode** -+----------+----------------------+ -| *Setter* | set_call_mode(value) | -+----------+----------------------+ -| *Getter* | get_call_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_call_mode(value) | ++-----------+----------------------+ +| *Getter* | get_call_mode() | ++-----------+----------------------+ .. _class_VisualScriptFunctionCall_property_function: - :ref:`String` **function** -+----------+---------------------+ -| *Setter* | set_function(value) | -+----------+---------------------+ -| *Getter* | get_function() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | "" | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ .. _class_VisualScriptFunctionCall_property_node_path: @@ -159,11 +165,13 @@ Property Descriptions - :ref:`RPCCallMode` **rpc_call_mode** -+----------+--------------------------+ -| *Setter* | set_rpc_call_mode(value) | -+----------+--------------------------+ -| *Getter* | get_rpc_call_mode() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_rpc_call_mode(value) | ++-----------+--------------------------+ +| *Getter* | get_rpc_call_mode() | ++-----------+--------------------------+ .. _class_VisualScriptFunctionCall_property_singleton: @@ -189,9 +197,11 @@ Property Descriptions - :ref:`bool` **validate** -+----------+---------------------+ -| *Setter* | set_validate(value) | -+----------+---------------------+ -| *Getter* | get_validate() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | true | ++-----------+---------------------+ +| *Setter* | set_validate(value) | ++-----------+---------------------+ +| *Getter* | get_validate() | ++-----------+---------------------+ diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 62bfe2a00..3d621c898 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`constant` | -+-----------------------+---------------------------------------------------------------------+ ++-----------------------+---------------------------------------------------------------------+---+ +| :ref:`int` | :ref:`constant` | 0 | ++-----------------------+---------------------------------------------------------------------+---+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`int` **constant** -+----------+----------------------------+ -| *Setter* | set_global_constant(value) | -+----------+----------------------------+ -| *Getter* | get_global_constant() | -+----------+----------------------------+ ++-----------+----------------------------+ +| *Default* | 0 | ++-----------+----------------------------+ +| *Setter* | set_global_constant(value) | ++-----------+----------------------------+ +| *Getter* | get_global_constant() | ++-----------+----------------------------+ diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index 2911cdad5..dc012f85c 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+------------------------------------------------+--------------------------------------------------------------+ -| :ref:`String` | :ref:`action` | -+------------------------------------------------+--------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+------------------------------------------------+--------------------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------+----+ +| :ref:`String` | :ref:`action` | "" | ++------------------------------------------------+--------------------------------------------------------------+----+ +| :ref:`Mode` | :ref:`mode` | 0 | ++------------------------------------------------+--------------------------------------------------------------+----+ Enumerations ------------ @@ -55,19 +55,23 @@ Property Descriptions - :ref:`String` **action** -+----------+------------------------+ -| *Setter* | set_action_name(value) | -+----------+------------------------+ -| *Getter* | get_action_name() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | "" | ++-----------+------------------------+ +| *Setter* | set_action_name(value) | ++-----------+------------------------+ +| *Getter* | get_action_name() | ++-----------+------------------------+ .. _class_VisualScriptInputAction_property_mode: - :ref:`Mode` **mode** -+----------+------------------------+ -| *Setter* | set_action_mode(value) | -+----------+------------------------+ -| *Getter* | get_action_mode() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_action_mode(value) | ++-----------+------------------------+ +| *Getter* | get_action_mode() | ++-----------+------------------------+ diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 921a9b1b6..75cf99590 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -19,11 +19,11 @@ Gets a local variable's value. Properties ---------- -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`var_name` | -+-----------------------------------------------------+---------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`Variant.Type` | :ref:`type` | 0 | ++-----------------------------------------------------+---------------------------------------------------------------+-------------+ +| :ref:`String` | :ref:`var_name` | "new_local" | ++-----------------------------------------------------+---------------------------------------------------------------+-------------+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`Variant.Type` **type** -+----------+---------------------+ -| *Setter* | set_var_type(value) | -+----------+---------------------+ -| *Getter* | get_var_type() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_var_type(value) | ++-----------+---------------------+ +| *Getter* | get_var_type() | ++-----------+---------------------+ The local variable's type. @@ -57,11 +59,13 @@ The local variable's type. - :ref:`String` **var_name** -+----------+---------------------+ -| *Setter* | set_var_name(value) | -+----------+---------------------+ -| *Getter* | get_var_name() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | "new_local" | ++-----------+---------------------+ +| *Setter* | set_var_name(value) | ++-----------+---------------------+ +| *Getter* | get_var_name() | ++-----------+---------------------+ The local variable's name. diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 07d3e8937..406d14b9c 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -19,11 +19,11 @@ Changes a local variable's value. Properties ---------- -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`String` | :ref:`var_name` | -+-----------------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------+-------------+ +| :ref:`Variant.Type` | :ref:`type` | 0 | ++-----------------------------------------------------+------------------------------------------------------------------+-------------+ +| :ref:`String` | :ref:`var_name` | "new_local" | ++-----------------------------------------------------+------------------------------------------------------------------+-------------+ Description ----------- @@ -49,11 +49,13 @@ Property Descriptions - :ref:`Variant.Type` **type** -+----------+---------------------+ -| *Setter* | set_var_type(value) | -+----------+---------------------+ -| *Getter* | get_var_type() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_var_type(value) | ++-----------+---------------------+ +| *Getter* | get_var_type() | ++-----------+---------------------+ The local variable's type. @@ -61,11 +63,13 @@ The local variable's type. - :ref:`String` **var_name** -+----------+---------------------+ -| *Setter* | set_var_name(value) | -+----------+---------------------+ -| *Getter* | get_var_name() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | "new_local" | ++-----------+---------------------+ +| *Setter* | set_var_name(value) | ++-----------+---------------------+ +| *Getter* | get_var_name() | ++-----------+---------------------+ The local variable's name. diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 90c93ba7c..928585f87 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -19,9 +19,9 @@ Commonly used mathematical constants. Properties ---------- -+-----------------------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`MathConstant` | :ref:`constant` | -+-----------------------------------------------------------------+-------------------------------------------------------------------+ ++-----------------------------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`MathConstant` | :ref:`constant` | 0 | ++-----------------------------------------------------------------+-------------------------------------------------------------------+---+ Enumerations ------------ @@ -86,11 +86,13 @@ Property Descriptions - :ref:`MathConstant` **constant** -+----------+--------------------------+ -| *Setter* | set_math_constant(value) | -+----------+--------------------------+ -| *Getter* | get_math_constant() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_math_constant(value) | ++-----------+--------------------------+ +| *Getter* | get_math_constant() | ++-----------+--------------------------+ The math constant. diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 151f2c16c..e2cff19e0 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+-------------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Variant.Operator` | :ref:`operator` | -+-------------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-------------------------------------------------------------+---------------------------------------------------------------+ ++-------------------------------------------------------------+---------------------------------------------------------------+---+ +| :ref:`Variant.Operator` | :ref:`operator` | 6 | ++-------------------------------------------------------------+---------------------------------------------------------------+---+ +| :ref:`Variant.Type` | :ref:`type` | 0 | ++-------------------------------------------------------------+---------------------------------------------------------------+---+ Description ----------- @@ -45,19 +45,23 @@ Property Descriptions - :ref:`Variant.Operator` **operator** -+----------+---------------------+ -| *Setter* | set_operator(value) | -+----------+---------------------+ -| *Getter* | get_operator() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 6 | ++-----------+---------------------+ +| *Setter* | set_operator(value) | ++-----------+---------------------+ +| *Getter* | get_operator() | ++-----------+---------------------+ .. _class_VisualScriptOperator_property_type: - :ref:`Variant.Type` **type** -+----------+------------------+ -| *Setter* | set_typed(value) | -+----------+------------------+ -| *Getter* | get_typed() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_typed(value) | ++-----------+------------------+ +| *Getter* | get_typed() | ++-----------+------------------+ diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index b002a748c..eafb2172b 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -19,9 +19,9 @@ Creates a new :ref:`Resource` or loads one from the filesystem. Properties ---------- -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Resource` | :ref:`resource` | -+---------------------------------+--------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------+------+ +| :ref:`Resource` | :ref:`resource` | null | ++---------------------------------+--------------------------------------------------------------+------+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`Resource` **resource** -+----------+--------------------+ -| *Setter* | set_preload(value) | -+----------+--------------------+ -| *Getter* | get_preload() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_preload(value) | ++-----------+--------------------+ +| *Getter* | get_preload() | ++-----------+--------------------+ The :ref:`Resource` to load. diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 5c87d0861..0fefe5d92 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -19,21 +19,21 @@ Brief Description Properties ---------- -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_script` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`index` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`property` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`CallMode` | :ref:`set_mode` | -+--------------------------------------------------------+------------------------------------------------------------------------+ ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_script` | | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_type` | "Object" | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`Variant.Type` | :ref:`basic_type` | | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`index` | | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`NodePath` | :ref:`node_path` | | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`property` | "" | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`CallMode` | :ref:`set_mode` | 0 | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ Enumerations ------------ @@ -71,11 +71,13 @@ Property Descriptions - :ref:`String` **base_type** -+----------+----------------------+ -| *Setter* | set_base_type(value) | -+----------+----------------------+ -| *Getter* | get_base_type() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "Object" | ++-----------+----------------------+ +| *Setter* | set_base_type(value) | ++-----------+----------------------+ +| *Getter* | get_base_type() | ++-----------+----------------------+ .. _class_VisualScriptPropertyGet_property_basic_type: @@ -111,19 +113,23 @@ Property Descriptions - :ref:`String` **property** -+----------+---------------------+ -| *Setter* | set_property(value) | -+----------+---------------------+ -| *Getter* | get_property() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | "" | ++-----------+---------------------+ +| *Setter* | set_property(value) | ++-----------+---------------------+ +| *Getter* | get_property() | ++-----------+---------------------+ .. _class_VisualScriptPropertyGet_property_set_mode: - :ref:`CallMode` **set_mode** -+----------+----------------------+ -| *Setter* | set_call_mode(value) | -+----------+----------------------+ -| *Getter* | get_call_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_call_mode(value) | ++-----------+----------------------+ +| *Getter* | get_call_mode() | ++-----------+----------------------+ diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 173260934..00066f7ee 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -19,23 +19,23 @@ Brief Description Properties ---------- -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`AssignOp` | :ref:`assign_op` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_script` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`index` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`property` | -+--------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`CallMode` | :ref:`set_mode` | -+--------------------------------------------------------+------------------------------------------------------------------------+ ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`AssignOp` | :ref:`assign_op` | 0 | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_script` | | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_type` | "Object" | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`Variant.Type` | :ref:`basic_type` | | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`index` | | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`NodePath` | :ref:`node_path` | | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`property` | "" | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ +| :ref:`CallMode` | :ref:`set_mode` | 0 | ++--------------------------------------------------------+------------------------------------------------------------------------+----------+ Enumerations ------------ @@ -115,11 +115,13 @@ Property Descriptions - :ref:`AssignOp` **assign_op** -+----------+----------------------+ -| *Setter* | set_assign_op(value) | -+----------+----------------------+ -| *Getter* | get_assign_op() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_assign_op(value) | ++-----------+----------------------+ +| *Getter* | get_assign_op() | ++-----------+----------------------+ .. _class_VisualScriptPropertySet_property_base_script: @@ -135,11 +137,13 @@ Property Descriptions - :ref:`String` **base_type** -+----------+----------------------+ -| *Setter* | set_base_type(value) | -+----------+----------------------+ -| *Getter* | get_base_type() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "Object" | ++-----------+----------------------+ +| *Setter* | set_base_type(value) | ++-----------+----------------------+ +| *Getter* | get_base_type() | ++-----------+----------------------+ .. _class_VisualScriptPropertySet_property_basic_type: @@ -175,19 +179,23 @@ Property Descriptions - :ref:`String` **property** -+----------+---------------------+ -| *Setter* | set_property(value) | -+----------+---------------------+ -| *Getter* | get_property() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | "" | ++-----------+---------------------+ +| *Setter* | set_property(value) | ++-----------+---------------------+ +| *Getter* | get_property() | ++-----------+---------------------+ .. _class_VisualScriptPropertySet_property_set_mode: - :ref:`CallMode` **set_mode** -+----------+----------------------+ -| *Setter* | set_call_mode(value) | -+----------+----------------------+ -| *Getter* | get_call_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_call_mode(value) | ++-----------+----------------------+ +| *Getter* | get_call_mode() | ++-----------+----------------------+ diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index 63bfc9812..79f1e690c 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`path` | -+-----------------------------+-----------------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------+----+ +| :ref:`String` | :ref:`path` | "" | ++-----------------------------+-----------------------------------------------------------+----+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`String` **path** -+----------+--------------------------+ -| *Setter* | set_resource_path(value) | -+----------+--------------------------+ -| *Getter* | get_resource_path() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | "" | ++-----------+--------------------------+ +| *Setter* | set_resource_path(value) | ++-----------+--------------------------+ +| *Getter* | get_resource_path() | ++-----------+--------------------------+ diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index a2acf5553..340aa37e1 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -19,11 +19,11 @@ Exits a function and returns an optional value. Properties ---------- -+-----------------------------------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`return_enabled` | -+-----------------------------------------------------+-------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`return_type` | -+-----------------------------------------------------+-------------------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`return_enabled` | false | ++-----------------------------------------------------+-------------------------------------------------------------------------+-------+ +| :ref:`Variant.Type` | :ref:`return_type` | 0 | ++-----------------------------------------------------+-------------------------------------------------------------------------+-------+ Description ----------- @@ -47,11 +47,13 @@ Property Descriptions - :ref:`bool` **return_enabled** -+----------+--------------------------------+ -| *Setter* | set_enable_return_value(value) | -+----------+--------------------------------+ -| *Getter* | is_return_value_enabled() | -+----------+--------------------------------+ ++-----------+--------------------------------+ +| *Default* | false | ++-----------+--------------------------------+ +| *Setter* | set_enable_return_value(value) | ++-----------+--------------------------------+ +| *Getter* | is_return_value_enabled() | ++-----------+--------------------------------+ If ``true``, the ``return`` input port is available. @@ -59,11 +61,13 @@ If ``true``, the ``return`` input port is available. - :ref:`Variant.Type` **return_type** -+----------+------------------------+ -| *Setter* | set_return_type(value) | -+----------+------------------------+ -| *Getter* | get_return_type() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | 0 | ++-----------+------------------------+ +| *Setter* | set_return_type(value) | ++-----------+------------------------+ +| *Getter* | get_return_type() | ++-----------+------------------------+ The return value's data type. diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index 2412e8dff..3ccd4bdd7 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -19,9 +19,9 @@ Node reference. Properties ---------- -+---------------------------------+------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+---------------------------------+------------------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------+---------------+ +| :ref:`NodePath` | :ref:`node_path` | NodePath(".") | ++---------------------------------+------------------------------------------------------------------+---------------+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`NodePath` **node_path** -+----------+----------------------+ -| *Setter* | set_node_path(value) | -+----------+----------------------+ -| *Getter* | get_node_path() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | NodePath(".") | ++-----------+----------------------+ +| *Setter* | set_node_path(value) | ++-----------+----------------------+ +| *Getter* | get_node_path() | ++-----------+----------------------+ The node's path in the scene tree. diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index e34906e5b..0e5a9abe1 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -19,9 +19,9 @@ Chooses between two input values. Properties ---------- -+-----------------------------------------------------+-----------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+-----------------------------------------------------+ ++-----------------------------------------------------+-----------------------------------------------------+---+ +| :ref:`Variant.Type` | :ref:`type` | 0 | ++-----------------------------------------------------+-----------------------------------------------------+---+ Description ----------- @@ -47,11 +47,13 @@ Property Descriptions - :ref:`Variant.Type` **type** -+----------+------------------+ -| *Setter* | set_typed(value) | -+----------+------------------+ -| *Getter* | get_typed() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 0 | ++-----------+------------------+ +| *Setter* | set_typed(value) | ++-----------+------------------+ +| *Getter* | get_typed() | ++-----------+------------------+ The input variables' type. diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index d75bfd49d..bb3622707 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -19,9 +19,9 @@ Executes a series of Sequence ports. Properties ---------- -+-----------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`steps` | -+-----------------------+---------------------------------------------------------+ ++-----------------------+---------------------------------------------------------+---+ +| :ref:`int` | :ref:`steps` | 1 | ++-----------------------+---------------------------------------------------------+---+ Description ----------- @@ -47,11 +47,13 @@ Property Descriptions - :ref:`int` **steps** -+----------+------------------+ -| *Setter* | set_steps(value) | -+----------+------------------+ -| *Getter* | get_steps() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | 1 | ++-----------+------------------+ +| *Setter* | set_steps(value) | ++-----------+------------------+ +| *Getter* | get_steps() | ++-----------+------------------+ The number of steps in the sequence. diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 5f5ba69ad..cc19fc4c2 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+-----------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_script` | -+-----------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+-----------------------------+---------------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_script` | "" | ++-----------------------------+---------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_type` | "Object" | ++-----------------------------+---------------------------------------------------------------------+----------+ Property Descriptions --------------------- @@ -32,19 +32,23 @@ Property Descriptions - :ref:`String` **base_script** -+----------+------------------------+ -| *Setter* | set_base_script(value) | -+----------+------------------------+ -| *Getter* | get_base_script() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | "" | ++-----------+------------------------+ +| *Setter* | set_base_script(value) | ++-----------+------------------------+ +| *Getter* | get_base_script() | ++-----------+------------------------+ .. _class_VisualScriptTypeCast_property_base_type: - :ref:`String` **base_type** -+----------+----------------------+ -| *Setter* | set_base_type(value) | -+----------+----------------------+ -| *Getter* | get_base_type() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "Object" | ++-----------+----------------------+ +| *Setter* | set_base_type(value) | ++-----------+----------------------+ +| *Getter* | get_base_type() | ++-----------+----------------------+ diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 9ba84d0e8..22b6a7acb 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -19,9 +19,9 @@ Gets a variable's value. Properties ---------- -+-----------------------------+------------------------------------------------------------------+ -| :ref:`String` | :ref:`var_name` | -+-----------------------------+------------------------------------------------------------------+ ++-----------------------------+------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`var_name` | "" | ++-----------------------------+------------------------------------------------------------------+----+ Description ----------- @@ -43,11 +43,13 @@ Property Descriptions - :ref:`String` **var_name** -+----------+---------------------+ -| *Setter* | set_variable(value) | -+----------+---------------------+ -| *Getter* | get_variable() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | "" | ++-----------+---------------------+ +| *Setter* | set_variable(value) | ++-----------+---------------------+ +| *Getter* | get_variable() | ++-----------+---------------------+ The variable's name. diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index f819ddba6..38dcd2312 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -19,9 +19,9 @@ Changes a variable's value. Properties ---------- -+-----------------------------+------------------------------------------------------------------+ -| :ref:`String` | :ref:`var_name` | -+-----------------------------+------------------------------------------------------------------+ ++-----------------------------+------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`var_name` | "" | ++-----------------------------+------------------------------------------------------------------+----+ Description ----------- @@ -45,11 +45,13 @@ Property Descriptions - :ref:`String` **var_name** -+----------+---------------------+ -| *Setter* | set_variable(value) | -+----------+---------------------+ -| *Getter* | get_variable() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | "" | ++-----------+---------------------+ +| *Setter* | set_variable(value) | ++-----------+---------------------+ +| *Getter* | get_variable() | ++-----------+---------------------+ The variable's name. diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 803e14d53..33d9bc802 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+----------------------------------------------------+--------------------------------------------------------------+ -| :ref:`YieldMode` | :ref:`mode` | -+----------------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`wait_time` | -+----------------------------------------------------+--------------------------------------------------------------+ ++----------------------------------------------------+--------------------------------------------------------------+---+ +| :ref:`YieldMode` | :ref:`mode` | 1 | ++----------------------------------------------------+--------------------------------------------------------------+---+ +| :ref:`float` | :ref:`wait_time` | | ++----------------------------------------------------+--------------------------------------------------------------+---+ Enumerations ------------ @@ -51,11 +51,13 @@ Property Descriptions - :ref:`YieldMode` **mode** -+----------+-----------------------+ -| *Setter* | set_yield_mode(value) | -+----------+-----------------------+ -| *Getter* | get_yield_mode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1 | ++-----------+-----------------------+ +| *Setter* | set_yield_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_yield_mode() | ++-----------+-----------------------+ .. _class_VisualScriptYield_property_wait_time: diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 85248e7b9..5854bad76 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -19,15 +19,15 @@ Brief Description Properties ---------- -+--------------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+--------------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`CallMode` | :ref:`call_mode` | -+--------------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+--------------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`signal` | -+--------------------------------------------------------+--------------------------------------------------------------------+ ++--------------------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`base_type` | "Object" | ++--------------------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`CallMode` | :ref:`call_mode` | 0 | ++--------------------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`NodePath` | :ref:`node_path` | | ++--------------------------------------------------------+--------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`signal` | "" | ++--------------------------------------------------------+--------------------------------------------------------------------+----------+ Enumerations ------------ @@ -55,21 +55,25 @@ Property Descriptions - :ref:`String` **base_type** -+----------+----------------------+ -| *Setter* | set_base_type(value) | -+----------+----------------------+ -| *Getter* | get_base_type() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | "Object" | ++-----------+----------------------+ +| *Setter* | set_base_type(value) | ++-----------+----------------------+ +| *Getter* | get_base_type() | ++-----------+----------------------+ .. _class_VisualScriptYieldSignal_property_call_mode: - :ref:`CallMode` **call_mode** -+----------+----------------------+ -| *Setter* | set_call_mode(value) | -+----------+----------------------+ -| *Getter* | get_call_mode() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | 0 | ++-----------+----------------------+ +| *Setter* | set_call_mode(value) | ++-----------+----------------------+ +| *Getter* | get_call_mode() | ++-----------+----------------------+ .. _class_VisualScriptYieldSignal_property_node_path: @@ -85,9 +89,11 @@ Property Descriptions - :ref:`String` **signal** -+----------+-------------------+ -| *Setter* | set_signal(value) | -+----------+-------------------+ -| *Getter* | get_signal() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | "" | ++-----------+-------------------+ +| *Setter* | set_signal(value) | ++-----------+-------------------+ +| *Getter* | get_signal() | ++-----------+-------------------+ diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index f0a212f32..9ddb3f0ff 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -839,7 +839,7 @@ This results in better-looking textures when viewed from oblique angles. - **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface. -- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. :ref:`TEXTURE_FLAG_MIPMAPS`, :ref:`TEXTURE_FLAG_REPEAT` and :ref:`TEXTURE_FLAG_FILTER` are are enabled. +- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. :ref:`TEXTURE_FLAG_MIPMAPS`, :ref:`TEXTURE_FLAG_REPEAT` and :ref:`TEXTURE_FLAG_FILTER` are enabled. .. _enum_VisualServer_ShaderMode: diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index 2c0e8dd3c..635c0205e 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`graph_offset` | -+-------------------------------+---------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------+-----------------+ +| :ref:`Vector2` | :ref:`graph_offset` | Vector2( 0, 0 ) | ++-------------------------------+---------------------------------------------------------------+-----------------+ Methods ------- @@ -99,11 +99,13 @@ Property Descriptions - :ref:`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 ------------------- diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index a08f725a4..9b693c920 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -21,11 +21,11 @@ Brief Description Properties ---------- -+---------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`default_input_values` | -+---------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`output_port_for_preview` | -+---------------------------+-----------------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------------+---------------------------+ +| :ref:`Array` | :ref:`default_input_values` | [ 0, Vector3( 0, 0, 0 ) ] | ++---------------------------+-----------------------------------------------------------------------------------------+---------------------------+ +| :ref:`int` | :ref:`output_port_for_preview` | -1 | ++---------------------------+-----------------------------------------------------------------------------------------+---------------------------+ Methods ------- @@ -50,15 +50,21 @@ Property Descriptions - :ref:`Array` **default_input_values** ++-----------+---------------------------+ +| *Default* | [ 0, Vector3( 0, 0, 0 ) ] | ++-----------+---------------------------+ + .. _class_VisualShaderNode_property_output_port_for_preview: - :ref:`int` **output_port_for_preview** -+----------+------------------------------------+ -| *Setter* | set_output_port_for_preview(value) | -+----------+------------------------------------+ -| *Getter* | get_output_port_for_preview() | -+----------+------------------------------------+ ++-----------+------------------------------------+ +| *Default* | -1 | ++-----------+------------------------------------+ +| *Setter* | set_output_port_for_preview(value) | ++-----------+------------------------------------+ +| *Getter* | get_output_port_for_preview() | ++-----------+------------------------------------+ Method Descriptions ------------------- diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst index 17fb9cb3b..7e0990297 100644 --- a/classes/class_visualshadernodebooleanconstant.rst +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`constant` | -+-------------------------+--------------------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`constant` | false | ++-------------------------+--------------------------------------------------------------------------+-------+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`bool` **constant** -+----------+---------------------+ -| *Setter* | set_constant(value) | -+----------+---------------------+ -| *Getter* | get_constant() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | false | ++-----------+---------------------+ +| *Setter* | set_constant(value) | ++-----------+---------------------+ +| *Getter* | get_constant() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index c07045f23..c185ddced 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+---------------------------+------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`constant` | -+---------------------------+------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------+---------------------+ +| :ref:`Color` | :ref:`constant` | Color( 1, 1, 1, 1 ) | ++---------------------------+------------------------------------------------------------------------+---------------------+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`Color` **constant** -+----------+---------------------+ -| *Setter* | set_constant(value) | -+----------+---------------------+ -| *Getter* | get_constant() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Color( 1, 1, 1, 1 ) | ++-----------+---------------------+ +| *Setter* | set_constant(value) | ++-----------+---------------------+ +| *Getter* | get_constant() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodecolorfunc.rst b/classes/class_visualshadernodecolorfunc.rst index 299c082c1..4e49f1ef3 100644 --- a/classes/class_visualshadernodecolorfunc.rst +++ b/classes/class_visualshadernodecolorfunc.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+----------------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Function` | :ref:`function` | -+----------------------------------------------------------+--------------------------------------------------------------------+ ++----------------------------------------------------------+--------------------------------------------------------------------+---+ +| :ref:`Function` | :ref:`function` | 0 | ++----------------------------------------------------------+--------------------------------------------------------------------+---+ Enumerations ------------ @@ -45,9 +45,11 @@ Property Descriptions - :ref:`Function` **function** -+----------+---------------------+ -| *Setter* | set_function(value) | -+----------+---------------------+ -| *Getter* | get_function() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index cc48a02b4..f4ccc449f 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+--------------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+--------------------------------------------------------+------------------------------------------------------------------+ ++--------------------------------------------------------+------------------------------------------------------------------+---+ +| :ref:`Operator` | :ref:`operator` | 0 | ++--------------------------------------------------------+------------------------------------------------------------------+---+ Enumerations ------------ @@ -73,9 +73,11 @@ Property Descriptions - :ref:`Operator` **operator** -+----------+---------------------+ -| *Setter* | set_operator(value) | -+----------+---------------------+ -| *Getter* | get_operator() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_operator(value) | ++-----------+---------------------+ +| *Getter* | get_operator() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 2df4ddb12..0385eba74 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`CubeMap` | :ref:`cube_map` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_type` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ ++--------------------------------------------------------------+--------------------------------------------------------------------------+------+ +| :ref:`CubeMap` | :ref:`cube_map` | null | ++--------------------------------------------------------------+--------------------------------------------------------------------------+------+ +| :ref:`TextureType` | :ref:`texture_type` | 0 | ++--------------------------------------------------------------+--------------------------------------------------------------------------+------+ Enumerations ------------ @@ -51,19 +51,23 @@ Property Descriptions - :ref:`CubeMap` **cube_map** -+----------+---------------------+ -| *Setter* | set_cube_map(value) | -+----------+---------------------+ -| *Getter* | get_cube_map() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | null | ++-----------+---------------------+ +| *Setter* | set_cube_map(value) | ++-----------+---------------------+ +| *Getter* | get_cube_map() | ++-----------+---------------------+ .. _class_VisualShaderNodeCubeMap_property_texture_type: - :ref:`TextureType` **texture_type** -+----------+-------------------------+ -| *Setter* | set_texture_type(value) | -+----------+-------------------------+ -| *Getter* | get_texture_type() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_texture_type(value) | ++-----------+-------------------------+ +| *Getter* | get_texture_type() | ++-----------+-------------------------+ diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst index 8eb7004b2..4ae354ad7 100644 --- a/classes/class_visualshadernodeexpression.rst +++ b/classes/class_visualshadernodeexpression.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------------+-------------------------------------------------------------------------+ -| :ref:`String` | :ref:`expression` | -+-----------------------------+-------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`expression` | "" | ++-----------------------------+-------------------------------------------------------------------------+----+ Methods ------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`String` **expression** -+----------+-----------------------+ -| *Setter* | set_expression(value) | -+----------+-----------------------+ -| *Getter* | get_expression() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | "" | ++-----------+-----------------------+ +| *Setter* | set_expression(value) | ++-----------+-----------------------+ +| *Getter* | get_expression() | ++-----------+-----------------------+ Method Descriptions ------------------- diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 1e42947a3..b6a7a55a1 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_name` | -+-----------------------------+--------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------+----------+ +| :ref:`String` | :ref:`input_name` | "[None]" | ++-----------------------------+--------------------------------------------------------------------+----------+ Signals ------- @@ -37,9 +37,11 @@ Property Descriptions - :ref:`String` **input_name** -+----------+-----------------------+ -| *Setter* | set_input_name(value) | -+----------+-----------------------+ -| *Getter* | get_input_name() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | "[None]" | ++-----------+-----------------------+ +| *Setter* | set_input_name(value) | ++-----------+-----------------------+ +| *Getter* | get_input_name() | ++-----------+-----------------------+ diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst index 8a3eab290..a88382126 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodescalarconstant.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`float` | :ref:`constant` | -+---------------------------+-------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------+-----+ +| :ref:`float` | :ref:`constant` | 0.0 | ++---------------------------+-------------------------------------------------------------------------+-----+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`float` **constant** -+----------+---------------------+ -| *Setter* | set_constant(value) | -+----------+---------------------+ -| *Getter* | get_constant() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0.0 | ++-----------+---------------------+ +| *Setter* | set_constant(value) | ++-----------+---------------------+ +| *Getter* | get_constant() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodescalarderivativefunc.rst b/classes/class_visualshadernodescalarderivativefunc.rst index 6cafc3b1a..2e40cfa8c 100644 --- a/classes/class_visualshadernodescalarderivativefunc.rst +++ b/classes/class_visualshadernodescalarderivativefunc.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Function` | :ref:`function` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+---+ +| :ref:`Function` | :ref:`function` | 0 | ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+---+ Enumerations ------------ @@ -49,9 +49,11 @@ Property Descriptions - :ref:`Function` **function** -+----------+---------------------+ -| *Setter* | set_function(value) | -+----------+---------------------+ -| *Getter* | get_function() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index f685a7687..80ceb4889 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`Function` | :ref:`function` | -+-----------------------------------------------------------+---------------------------------------------------------------------+ ++-----------------------------------------------------------+---------------------------------------------------------------------+----+ +| :ref:`Function` | :ref:`function` | 13 | ++-----------------------------------------------------------+---------------------------------------------------------------------+----+ Enumerations ------------ @@ -165,9 +165,11 @@ Property Descriptions - :ref:`Function` **function** -+----------+---------------------+ -| *Setter* | set_function(value) | -+----------+---------------------+ -| *Getter* | get_function() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 13 | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index 05087ee17..636bc478d 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+---------------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+---------------------------------------------------------+-------------------------------------------------------------------+ ++---------------------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`Operator` | :ref:`operator` | 0 | ++---------------------------------------------------------+-------------------------------------------------------------------+---+ Enumerations ------------ @@ -77,9 +77,11 @@ Property Descriptions - :ref:`Operator` **operator** -+----------+---------------------+ -| *Setter* | set_operator(value) | -+----------+---------------------+ -| *Getter* | get_operator() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_operator(value) | ++-----------+---------------------+ +| *Getter* | get_operator() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 0f0eb0b95..0078dd2a1 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -19,13 +19,13 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`Source` | :ref:`source` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_type` | -+--------------------------------------------------------------+--------------------------------------------------------------------------+ ++--------------------------------------------------------------+--------------------------------------------------------------------------+------+ +| :ref:`Source` | :ref:`source` | 0 | ++--------------------------------------------------------------+--------------------------------------------------------------------------+------+ +| :ref:`Texture` | :ref:`texture` | null | ++--------------------------------------------------------------+--------------------------------------------------------------------------+------+ +| :ref:`TextureType` | :ref:`texture_type` | 0 | ++--------------------------------------------------------------+--------------------------------------------------------------------------+------+ Enumerations ------------ @@ -73,29 +73,35 @@ Property Descriptions - :ref:`Source` **source** -+----------+-------------------+ -| *Setter* | set_source(value) | -+----------+-------------------+ -| *Getter* | get_source() | -+----------+-------------------+ ++-----------+-------------------+ +| *Default* | 0 | ++-----------+-------------------+ +| *Setter* | set_source(value) | ++-----------+-------------------+ +| *Getter* | get_source() | ++-----------+-------------------+ .. _class_VisualShaderNodeTexture_property_texture: - :ref:`Texture` **texture** -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ ++-----------+--------------------+ +| *Default* | null | ++-----------+--------------------+ +| *Setter* | set_texture(value) | ++-----------+--------------------+ +| *Getter* | get_texture() | ++-----------+--------------------+ .. _class_VisualShaderNodeTexture_property_texture_type: - :ref:`TextureType` **texture_type** -+----------+-------------------------+ -| *Setter* | set_texture_type(value) | -+----------+-------------------------+ -| *Getter* | get_texture_type() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_texture_type(value) | ++-----------+-------------------------+ +| *Getter* | get_texture_type() | ++-----------+-------------------------+ diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index 4bd44da1d..a2d5a45d2 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`ColorDefault` | :ref:`color_default` | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_type` | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---+ +| :ref:`ColorDefault` | :ref:`color_default` | 0 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---+ +| :ref:`TextureType` | :ref:`texture_type` | 0 | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---+ Enumerations ------------ @@ -67,19 +67,23 @@ Property Descriptions - :ref:`ColorDefault` **color_default** -+----------+--------------------------+ -| *Setter* | set_color_default(value) | -+----------+--------------------------+ -| *Getter* | get_color_default() | -+----------+--------------------------+ ++-----------+--------------------------+ +| *Default* | 0 | ++-----------+--------------------------+ +| *Setter* | set_color_default(value) | ++-----------+--------------------------+ +| *Getter* | get_color_default() | ++-----------+--------------------------+ .. _class_VisualShaderNodeTextureUniform_property_texture_type: - :ref:`TextureType` **texture_type** -+----------+-------------------------+ -| *Setter* | set_texture_type(value) | -+----------+-------------------------+ -| *Getter* | get_texture_type() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | 0 | ++-----------+-------------------------+ +| *Setter* | set_texture_type(value) | ++-----------+-------------------------+ +| *Getter* | get_texture_type() | ++-----------+-------------------------+ diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index 175129128..14c291985 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------------------+----------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`constant` | -+-----------------------------------+----------------------------------------------------------------------------+ ++-----------------------------------+----------------------------------------------------------------------------+-------------------------------------------------+ +| :ref:`Transform` | :ref:`constant` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------------------------------+----------------------------------------------------------------------------+-------------------------------------------------+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`Transform` **constant** -+----------+---------------------+ -| *Setter* | set_constant(value) | -+----------+---------------------+ -| *Getter* | get_constant() | -+----------+---------------------+ ++-----------+-------------------------------------------------+ +| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) | ++-----------+-------------------------------------------------+ +| *Setter* | set_constant(value) | ++-----------+-------------------------------------------------+ +| *Getter* | get_constant() | ++-----------+-------------------------------------------------+ diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst index 80a714d62..37af27a59 100644 --- a/classes/class_visualshadernodetransformfunc.rst +++ b/classes/class_visualshadernodetransformfunc.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Function` | :ref:`function` | -+--------------------------------------------------------------+------------------------------------------------------------------------+ ++--------------------------------------------------------------+------------------------------------------------------------------------+---+ +| :ref:`Function` | :ref:`function` | 0 | ++--------------------------------------------------------------+------------------------------------------------------------------------+---+ Enumerations ------------ @@ -45,9 +45,11 @@ Property Descriptions - :ref:`Function` **function** -+----------+---------------------+ -| *Setter* | set_function(value) | -+----------+---------------------+ -| *Getter* | get_function() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 5708a9b34..d33bc111b 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+--------------------------------------------------------------+------------------------------------------------------------------------+ ++--------------------------------------------------------------+------------------------------------------------------------------------+---+ +| :ref:`Operator` | :ref:`operator` | 0 | ++--------------------------------------------------------------+------------------------------------------------------------------------+---+ Enumerations ------------ @@ -53,9 +53,11 @@ Property Descriptions - :ref:`Operator` **operator** -+----------+---------------------+ -| *Setter* | set_operator(value) | -+----------+---------------------+ -| *Getter* | get_operator() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_operator(value) | ++-----------+---------------------+ +| *Getter* | get_operator() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index e6dc7bc05..381217a0a 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------+ ++-----------------------------------------------------------------+---------------------------------------------------------------------------+---+ +| :ref:`Operator` | :ref:`operator` | 0 | ++-----------------------------------------------------------------+---------------------------------------------------------------------------+---+ Enumerations ------------ @@ -53,9 +53,11 @@ Property Descriptions - :ref:`Operator` **operator** -+----------+---------------------+ -| *Setter* | set_operator(value) | -+----------+---------------------+ -| *Getter* | get_operator() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_operator(value) | ++-----------+---------------------+ +| *Getter* | get_operator() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index 7f8c871ad..5b9aded27 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -21,9 +21,9 @@ Brief Description Properties ---------- -+-----------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`uniform_name` | -+-----------------------------+--------------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------+----+ +| :ref:`String` | :ref:`uniform_name` | "" | ++-----------------------------+--------------------------------------------------------------------------+----+ Property Descriptions --------------------- @@ -32,9 +32,11 @@ Property Descriptions - :ref:`String` **uniform_name** -+----------+-------------------------+ -| *Setter* | set_uniform_name(value) | -+----------+-------------------------+ -| *Getter* | get_uniform_name() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | "" | ++-----------+-------------------------+ +| *Setter* | set_uniform_name(value) | ++-----------+-------------------------+ +| *Getter* | get_uniform_name() | ++-----------+-------------------------+ diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index a3a562dd8..32975e602 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`constant` | -+-------------------------------+-----------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------+--------------------+ +| :ref:`Vector3` | :ref:`constant` | Vector3( 0, 0, 0 ) | ++-------------------------------+-----------------------------------------------------------------------+--------------------+ Property Descriptions --------------------- @@ -30,9 +30,11 @@ Property Descriptions - :ref:`Vector3` **constant** -+----------+---------------------+ -| *Setter* | set_constant(value) | -+----------+---------------------+ -| *Getter* | get_constant() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | Vector3( 0, 0, 0 ) | ++-----------+---------------------+ +| *Setter* | set_constant(value) | ++-----------+---------------------+ +| *Getter* | get_constant() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodevectorderivativefunc.rst b/classes/class_visualshadernodevectorderivativefunc.rst index 68c70107b..5ef424fde 100644 --- a/classes/class_visualshadernodevectorderivativefunc.rst +++ b/classes/class_visualshadernodevectorderivativefunc.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Function` | :ref:`function` | -+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+---+ +| :ref:`Function` | :ref:`function` | 0 | ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+---+ Enumerations ------------ @@ -49,9 +49,11 @@ Property Descriptions - :ref:`Function` **function** -+----------+---------------------+ -| *Setter* | set_function(value) | -+----------+---------------------+ -| *Getter* | get_function() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index 38db44d90..30a6d4a70 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+-----------------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`Function` | :ref:`function` | -+-----------------------------------------------------------+---------------------------------------------------------------------+ ++-----------------------------------------------------------+---------------------------------------------------------------------+---+ +| :ref:`Function` | :ref:`function` | 0 | ++-----------------------------------------------------------+---------------------------------------------------------------------+---+ Enumerations ------------ @@ -177,9 +177,11 @@ Property Descriptions - :ref:`Function` **function** -+----------+---------------------+ -| *Setter* | set_function(value) | -+----------+---------------------+ -| *Getter* | get_function() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index 461797b00..d39d70f84 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -19,9 +19,9 @@ Brief Description Properties ---------- -+---------------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+---------------------------------------------------------+-------------------------------------------------------------------+ ++---------------------------------------------------------+-------------------------------------------------------------------+---+ +| :ref:`Operator` | :ref:`operator` | 0 | ++---------------------------------------------------------+-------------------------------------------------------------------+---+ Enumerations ------------ @@ -85,9 +85,11 @@ Property Descriptions - :ref:`Operator` **operator** -+----------+---------------------+ -| *Setter* | set_operator(value) | -+----------+---------------------+ -| *Getter* | get_operator() | -+----------+---------------------+ ++-----------+---------------------+ +| *Default* | 0 | ++-----------+---------------------+ +| *Setter* | set_operator(value) | ++-----------+---------------------+ +| *Getter* | get_operator() | ++-----------+---------------------+ diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index 4f9e8e455..4a1af5c57 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -19,11 +19,11 @@ Vertical version of :ref:`Separator`. Theme Properties ---------------- -+---------------------------------+------------+ -| :ref:`int` | separation | -+---------------------------------+------------+ -| :ref:`StyleBox` | separator | -+---------------------------------+------------+ ++---------------------------------+------------+---+ +| :ref:`int` | separation | 4 | ++---------------------------------+------------+---+ +| :ref:`StyleBox` | separator | | ++---------------------------------+------------+---+ Description ----------- diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index e92e5a75f..4fb5b982b 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -19,15 +19,15 @@ Vertical split container. Theme Properties ---------------- -+---------------------------------+------------+ -| :ref:`int` | autohide | -+---------------------------------+------------+ -| :ref:`StyleBox` | bg | -+---------------------------------+------------+ -| :ref:`Texture` | grabber | -+---------------------------------+------------+ -| :ref:`int` | separation | -+---------------------------------+------------+ ++---------------------------------+------------+----+ +| :ref:`int` | autohide | 1 | ++---------------------------------+------------+----+ +| :ref:`StyleBox` | bg | | ++---------------------------------+------------+----+ +| :ref:`Texture` | grabber | | ++---------------------------------+------------+----+ +| :ref:`int` | separation | 12 | ++---------------------------------+------------+----+ Description ----------- diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index 6ad74d017..0408bfdff 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -21,9 +21,9 @@ Brief Description Properties ---------- -+----------------------------------------------------+----------------------------------------------------------------+ -| :ref:`WriteMode` | :ref:`write_mode` | -+----------------------------------------------------+----------------------------------------------------------------+ ++----------------------------------------------------+----------------------------------------------------------------+---+ +| :ref:`WriteMode` | :ref:`write_mode` | 1 | ++----------------------------------------------------+----------------------------------------------------------------+---+ Methods ------- @@ -94,11 +94,13 @@ Property Descriptions - :ref:`WriteMode` **write_mode** -+----------+-----------------------+ -| *Setter* | set_write_mode(value) | -+----------+-----------------------+ -| *Getter* | get_write_mode() | -+----------+-----------------------+ ++-----------+-----------------------+ +| *Default* | 1 | ++-----------+-----------------------+ +| *Setter* | set_write_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_write_mode() | ++-----------+-----------------------+ The transfer mode to use when sending outgoing packet. Either text or binary. diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index dee4086c0..cf6a6410b 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -21,11 +21,11 @@ Base class for window dialogs. Properties ---------- -+-----------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`resizable` | -+-----------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`window_title` | -+-----------------------------+---------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------+-------+ +| :ref:`bool` | :ref:`resizable` | false | ++-----------------------------+---------------------------------------------------------------+-------+ +| :ref:`String` | :ref:`window_title` | "" | ++-----------------------------+---------------------------------------------------------------+-------+ Methods ------- @@ -37,25 +37,25 @@ Methods Theme Properties ---------------- -+---------------------------------+------------------+ -| :ref:`Texture` | close | -+---------------------------------+------------------+ -| :ref:`int` | close_h_ofs | -+---------------------------------+------------------+ -| :ref:`Texture` | close_highlight | -+---------------------------------+------------------+ -| :ref:`int` | close_v_ofs | -+---------------------------------+------------------+ -| :ref:`StyleBox` | panel | -+---------------------------------+------------------+ -| :ref:`int` | scaleborder_size | -+---------------------------------+------------------+ -| :ref:`Color` | title_color | -+---------------------------------+------------------+ -| :ref:`Font` | title_font | -+---------------------------------+------------------+ -| :ref:`int` | title_height | -+---------------------------------+------------------+ ++---------------------------------+------------------+---------------------+ +| :ref:`Texture` | close | | ++---------------------------------+------------------+---------------------+ +| :ref:`int` | close_h_ofs | 18 | ++---------------------------------+------------------+---------------------+ +| :ref:`Texture` | close_highlight | | ++---------------------------------+------------------+---------------------+ +| :ref:`int` | close_v_ofs | 18 | ++---------------------------------+------------------+---------------------+ +| :ref:`StyleBox` | panel | | ++---------------------------------+------------------+---------------------+ +| :ref:`int` | scaleborder_size | 4 | ++---------------------------------+------------------+---------------------+ +| :ref:`Color` | title_color | Color( 0, 0, 0, 1 ) | ++---------------------------------+------------------+---------------------+ +| :ref:`Font` | title_font | | ++---------------------------------+------------------+---------------------+ +| :ref:`int` | title_height | 20 | ++---------------------------------+------------------+---------------------+ Description ----------- @@ -69,23 +69,27 @@ Property Descriptions - :ref:`bool` **resizable** -+----------+----------------------+ -| *Setter* | set_resizable(value) | -+----------+----------------------+ -| *Getter* | get_resizable() | -+----------+----------------------+ ++-----------+----------------------+ +| *Default* | false | ++-----------+----------------------+ +| *Setter* | set_resizable(value) | ++-----------+----------------------+ +| *Getter* | get_resizable() | ++-----------+----------------------+ -If ``true``, the user can resize the window. Default value: ``false``. +If ``true``, the user can resize the window. .. _class_WindowDialog_property_window_title: - :ref:`String` **window_title** -+----------+------------------+ -| *Setter* | set_title(value) | -+----------+------------------+ -| *Getter* | get_title() | -+----------+------------------+ ++-----------+------------------+ +| *Default* | "" | ++-----------+------------------+ +| *Setter* | set_title(value) | ++-----------+------------------+ +| *Getter* | get_title() | ++-----------+------------------+ The text displayed in the window's title bar. diff --git a/classes/class_world.rst b/classes/class_world.rst index e82aaa6e3..5617fbe71 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -19,17 +19,17 @@ Class that has everything pertaining to a world. Properties ---------- -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`direct_space_state` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`environment` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`fallback_environment` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------+------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`direct_space_state` | | ++---------------------------------------------------------------+------------------------------------------------------------------------+------+ +| :ref:`Environment` | :ref:`environment` | null | ++---------------------------------------------------------------+------------------------------------------------------------------------+------+ +| :ref:`Environment` | :ref:`fallback_environment` | null | ++---------------------------------------------------------------+------------------------------------------------------------------------+------+ +| :ref:`RID` | :ref:`scenario` | | ++---------------------------------------------------------------+------------------------------------------------------------------------+------+ +| :ref:`RID` | :ref:`space` | | ++---------------------------------------------------------------+------------------------------------------------------------------------+------+ Description ----------- @@ -58,11 +58,13 @@ The World's physics direct space state, used for making various queries. Might b - :ref:`Environment` **environment** -+----------+------------------------+ -| *Setter* | set_environment(value) | -+----------+------------------------+ -| *Getter* | get_environment() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_environment(value) | ++-----------+------------------------+ +| *Getter* | get_environment() | ++-----------+------------------------+ The World's :ref:`Environment`. @@ -70,11 +72,13 @@ The World's :ref:`Environment`. - :ref:`Environment` **fallback_environment** -+----------+---------------------------------+ -| *Setter* | set_fallback_environment(value) | -+----------+---------------------------------+ -| *Getter* | get_fallback_environment() | -+----------+---------------------------------+ ++-----------+---------------------------------+ +| *Default* | null | ++-----------+---------------------------------+ +| *Setter* | set_fallback_environment(value) | ++-----------+---------------------------------+ +| *Getter* | get_fallback_environment() | ++-----------+---------------------------------+ The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 575753b40..eaba55707 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -19,9 +19,9 @@ Default environment properties for the entire scene (post-processing effects, li Properties ---------- -+---------------------------------------+-----------------------------------------------------------------+ -| :ref:`Environment` | :ref:`environment` | -+---------------------------------------+-----------------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------+------+ +| :ref:`Environment` | :ref:`environment` | null | ++---------------------------------------+-----------------------------------------------------------------+------+ Description ----------- @@ -44,11 +44,13 @@ Property Descriptions - :ref:`Environment` **environment** -+----------+------------------------+ -| *Setter* | set_environment(value) | -+----------+------------------------+ -| *Getter* | get_environment() | -+----------+------------------------+ ++-----------+------------------------+ +| *Default* | null | ++-----------+------------------------+ +| *Setter* | set_environment(value) | ++-----------+------------------------+ +| *Getter* | get_environment() | ++-----------+------------------------+ The :ref:`Environment` resource used by this ``WorldEnvironment``, defining the default properties. diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index 61f762996..cd4cab413 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -19,9 +19,9 @@ Sort all child nodes based on their Y positions. Properties ---------- -+-------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`sort_enabled` | -+-------------------------+--------------------------------------------------------+ ++-------------------------+--------------------------------------------------------+------+ +| :ref:`bool` | :ref:`sort_enabled` | true | ++-------------------------+--------------------------------------------------------+------+ Description ----------- @@ -37,11 +37,13 @@ Property Descriptions - :ref:`bool` **sort_enabled** -+----------+-------------------------+ -| *Setter* | set_sort_enabled(value) | -+----------+-------------------------+ -| *Getter* | is_sort_enabled() | -+----------+-------------------------+ ++-----------+-------------------------+ +| *Default* | true | ++-----------+-------------------------+ +| *Setter* | set_sort_enabled(value) | ++-----------+-------------------------+ +| *Getter* | is_sort_enabled() | ++-----------+-------------------------+ -If ``true``, child nodes are sorted, otherwise sorting is disabled. Default: ``true``. +If ``true``, child nodes are sorted, otherwise sorting is disabled.