diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 86d21aaeb..61c535f0d 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -44,7 +44,7 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`clamp` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | +| :ref:`Variant` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -70,7 +70,9 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | +| :ref:`FuncRef` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_stack` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -92,7 +94,7 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`load` **(** :ref:`String` path **)** | +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -112,6 +114,8 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print` **(** **)** vararg | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_debug` **(** **)** vararg | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print_stack` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`printerr` **(** **)** vararg | @@ -172,7 +176,7 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`weakref` **(** :ref:`Object` obj **)** | +| :ref:`WeakRef` | :ref:`weakref` **(** :ref:`Object` obj **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`wrapf` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -194,7 +198,7 @@ The NaN values are used to identify undefined or non-representable values for fl Description ----------- -This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects. +List of core built-in GDScript functions. Math functions and other utilities. Everything else is provided by objects. (Keywords: builtin, built in, global functions.) Member Function Description --------------------------- @@ -354,7 +358,7 @@ Clamps ``value`` and returns a value not less than ``min`` and not more than ``m .. _class_@GDScript_convert: -- :ref:`Object` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** +- :ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@GlobalScope`. @@ -508,7 +512,7 @@ Produces: .. _class_@GDScript_funcref: -- :ref:`Object` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** +- :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** Returns a reference to the specified function ``funcname`` in the ``instance`` node. As functions aren't first-class objects in GDscript, use ``funcref`` to store a :ref:`FuncRef` in a variable and call it later. @@ -520,6 +524,10 @@ Returns a reference to the specified function ``funcname`` in the ``instance`` n a = funcref(self, "foo") print(a.call_func()) # prints bar +.. _class_@GDScript_get_stack: + +- void **get_stack** **(** **)** + .. _class_@GDScript_hash: - :ref:`int` **hash** **(** :ref:`Variant` var **)** @@ -595,7 +603,9 @@ Returns True/False whether ``s`` is a NaN (Not-A-Number) value. - :ref:`int` **len** **(** :ref:`Variant` var **)** -Returns length of Variant ``var``. Length is the character count of String, element count of Array, size of Dictionary, etc. Note: Generates a fatal error if Variant can not provide a length. +Returns length of Variant ``var``. Length is the character count of String, element count of Array, size of Dictionary, etc. + +**Note:** Generates a fatal error if Variant can not provide a length. :: @@ -620,9 +630,11 @@ Converts from linear energy to decibels (audio). .. _class_@GDScript_load: -- :ref:`Object` **load** **(** :ref:`String` path **)** +- :ref:`Resource` **load** **(** :ref:`String` path **)** -Loads a resource from the filesystem located at ``path``. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". +Loads a resource from the filesystem located at ``path``. + +**Note:** Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". :: @@ -633,7 +645,9 @@ Loads a resource from the filesystem located at ``path``. Note: resource paths c - :ref:`float` **log** **(** :ref:`float` s **)** -Natural logarithm. The amount of time needed to reach a certain level of continuous growth. Note: This is not the same as the log function on your calculator which is a base 10 logarithm. +Natural logarithm. The amount of time needed to reach a certain level of continuous growth. + +**Note:** This is not the same as the log function on your calculator which is a base 10 logarithm. :: @@ -711,7 +725,9 @@ Returns the result of ``x`` raised to the power of ``y``. - :ref:`Resource` **preload** **(** :ref:`String` path **)** -Returns a resource from the filesystem that is loaded during script parsing. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". +Returns a resource from the filesystem that is loaded during script parsing. + +**Note:** Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". :: @@ -729,6 +745,10 @@ Converts one or more arguments to strings in the best way possible and prints th a = [1,2,3] print("a","b",a) # prints ab[1, 2, 3] +.. _class_@GDScript_print_debug: + +- void **print_debug** **(** **)** vararg + .. _class_@GDScript_print_stack: - void **print_stack** **(** **)** @@ -1080,7 +1100,7 @@ prints .. _class_@GDScript_weakref: -- :ref:`Object` **weakref** **(** :ref:`Object` obj **)** +- :ref:`WeakRef` **weakref** **(** :ref:`Object` obj **)** Returns a weak reference to an object. @@ -1136,8 +1156,10 @@ Usable for creating loop-alike behavior or infinite surfaces. - :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object=null, :ref:`String` signal="" **)** -Stops the function execution and returns the current state. Call :ref:`GDScriptFunctionState.resume` on the state to resume execution. This invalidates the state. +Stops the function execution and returns the current suspended state to the calling function. -Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted. +From the caller, call :ref:`GDScriptFunctionState.resume` on the state to resume execution. This invalidates the state. Within the resumed function, ``yield()`` returns whatever was passed to the ``resume()`` function call. + +If passed an object and a signal, the execution is resumed when the object emits the given signal. In this case, ``yield()`` returns the argument passed to ``emit_signal()`` if the signal takes only one argument, or an array containing all the arguments passed to ``emit_signal()`` if the signal takes multiple arguments. diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index dee8e02c4..a453dc8b9 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -37,10 +37,6 @@ Member Variables - :ref:`Geometry` **Geometry** - :ref:`Geometry` singleton - .. _class_@GlobalScope_GodotSharp: - -- :ref:`GodotSharp` **GodotSharp** - :ref:`GodotSharp` singleton - .. _class_@GlobalScope_IP: - :ref:`IP` **IP** - :ref:`IP` singleton @@ -250,6 +246,40 @@ enum **JoystickList** - **JOY_ANALOG_L2** = **6** --- Joypad Left Analog Trigger - **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger + .. _enum_@GlobalScope_MidiMessageList: + +enum **MidiMessageList** + +- **MIDI_MESSAGE_NOTE_OFF** = **8** +- **MIDI_MESSAGE_NOTE_ON** = **9** +- **MIDI_MESSAGE_AFTERTOUCH** = **10** +- **MIDI_MESSAGE_CONTROL_CHANGE** = **11** +- **MIDI_MESSAGE_PROGRAM_CHANGE** = **12** +- **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13** +- **MIDI_MESSAGE_PITCH_BEND** = **14** + + .. _enum_@GlobalScope_KeyModifierMask: + +enum **KeyModifierMask** + +- **KEY_CODE_MASK** = **33554431** --- Key Code Mask +- **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask +- **KEY_MASK_SHIFT** = **33554432** --- Shift Key Mask +- **KEY_MASK_ALT** = **67108864** --- Alt Key Mask +- **KEY_MASK_META** = **134217728** --- Meta Key Mask +- **KEY_MASK_CTRL** = **268435456** --- CTRL Key Mask +- **KEY_MASK_CMD** = **268435456** --- CMD Key Mask +- **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask +- **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask + + .. _enum_@GlobalScope_HAlign: + +enum **HAlign** + +- **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes. +- **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes. +- **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes. + .. _enum_@GlobalScope_Error: enum **Error** @@ -296,28 +326,6 @@ enum **Error** - **ERR_HELP** = **46** --- Help error - **ERR_BUG** = **47** --- Bug error - .. _enum_@GlobalScope_KeyModifierMask: - -enum **KeyModifierMask** - -- **KEY_CODE_MASK** = **33554431** --- Key Code Mask -- **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask -- **KEY_MASK_SHIFT** = **33554432** --- Shift Key Mask -- **KEY_MASK_ALT** = **67108864** --- Alt Key Mask -- **KEY_MASK_META** = **134217728** --- Meta Key Mask -- **KEY_MASK_CTRL** = **268435456** --- CTRL Key Mask -- **KEY_MASK_CMD** = **268435456** --- CMD Key Mask -- **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask -- **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask - - .. _enum_@GlobalScope_HAlign: - -enum **HAlign** - -- **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes. -- **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes. -- **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes. - .. _enum_@GlobalScope_VAlign: enum **VAlign** @@ -348,9 +356,10 @@ enum **PropertyHint** - **PROPERTY_HINT_GLOBAL_DIR** = **16** - **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- String property is a resource, so open the resource popup menu when edited. - **PROPERTY_HINT_MULTILINE_TEXT** = **18** -- **PROPERTY_HINT_COLOR_NO_ALPHA** = **19** -- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **20** --- Hints that the image is compressed using lossy compression. -- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **21** --- Hints that the image is compressed using lossless compression. +- **PROPERTY_HINT_PLACEHOLDER_TEXT** = **19** +- **PROPERTY_HINT_COLOR_NO_ALPHA** = **20** +- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that the image is compressed using lossy compression. +- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that the image is compressed using lossless compression. .. _enum_@GlobalScope_Corner: @@ -657,6 +666,8 @@ enum **ButtonList** - **BUTTON_LEFT** = **1** --- Left Mouse Button - **BUTTON_RIGHT** = **2** --- Right Mouse Button - **BUTTON_MIDDLE** = **3** --- Middle Mouse Button +- **BUTTON_XBUTTON1** = **8** +- **BUTTON_XBUTTON2** = **9** - **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up - **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down - **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button @@ -664,6 +675,8 @@ enum **ButtonList** - **BUTTON_MASK_LEFT** = **1** --- Left Mouse Button Mask - **BUTTON_MASK_RIGHT** = **2** --- Right Mouse Button Mask - **BUTTON_MASK_MIDDLE** = **4** --- Middle Mouse Button Mask +- **BUTTON_MASK_XBUTTON1** = **128** +- **BUTTON_MASK_XBUTTON2** = **256** Description diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 68b590e8b..6355c8611 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -82,6 +82,11 @@ Description AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. +Tutorials +--------- + +- :doc:`../tutorials/math/index` + Member Function Description --------------------------- diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index bfe8e2c18..2fcd680e0 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -40,7 +40,7 @@ Signals - **confirmed** **(** **)** -Emitted when the dialog is accepted. +Emitted when the dialog is accepted, i.e. the OK button is pressed. .. _class_AcceptDialog_custom_action: @@ -54,7 +54,9 @@ Member Variables .. _class_AcceptDialog_dialog_hide_on_ok: -- :ref:`bool` **dialog_hide_on_ok** - If ``true`` the dialog is hidden when accepted. Default value: ``true``. +- :ref:`bool` **dialog_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``. + +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. .. _class_AcceptDialog_dialog_text: diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst new file mode 100644 index 000000000..b08168b0e --- /dev/null +++ b/classes/class_animatedtexture.rst @@ -0,0 +1,2078 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimatedTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimatedTexture: + +AnimatedTexture +=============== + +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_AnimatedTexture_fps: + +- :ref:`float` **fps** + + .. _class_AnimatedTexture_frame_0/delay_sec: + +- :ref:`float` **frame_0/delay_sec** + + .. _class_AnimatedTexture_frame_0/texture: + +- :ref:`Texture` **frame_0/texture** + + .. _class_AnimatedTexture_frame_1/delay_sec: + +- :ref:`float` **frame_1/delay_sec** + + .. _class_AnimatedTexture_frame_1/texture: + +- :ref:`Texture` **frame_1/texture** + + .. _class_AnimatedTexture_frame_10/delay_sec: + +- :ref:`float` **frame_10/delay_sec** + + .. _class_AnimatedTexture_frame_10/texture: + +- :ref:`Texture` **frame_10/texture** + + .. _class_AnimatedTexture_frame_100/delay_sec: + +- :ref:`float` **frame_100/delay_sec** + + .. _class_AnimatedTexture_frame_100/texture: + +- :ref:`Texture` **frame_100/texture** + + .. _class_AnimatedTexture_frame_101/delay_sec: + +- :ref:`float` **frame_101/delay_sec** + + .. _class_AnimatedTexture_frame_101/texture: + +- :ref:`Texture` **frame_101/texture** + + .. _class_AnimatedTexture_frame_102/delay_sec: + +- :ref:`float` **frame_102/delay_sec** + + .. _class_AnimatedTexture_frame_102/texture: + +- :ref:`Texture` **frame_102/texture** + + .. _class_AnimatedTexture_frame_103/delay_sec: + +- :ref:`float` **frame_103/delay_sec** + + .. _class_AnimatedTexture_frame_103/texture: + +- :ref:`Texture` **frame_103/texture** + + .. _class_AnimatedTexture_frame_104/delay_sec: + +- :ref:`float` **frame_104/delay_sec** + + .. _class_AnimatedTexture_frame_104/texture: + +- :ref:`Texture` **frame_104/texture** + + .. _class_AnimatedTexture_frame_105/delay_sec: + +- :ref:`float` **frame_105/delay_sec** + + .. _class_AnimatedTexture_frame_105/texture: + +- :ref:`Texture` **frame_105/texture** + + .. _class_AnimatedTexture_frame_106/delay_sec: + +- :ref:`float` **frame_106/delay_sec** + + .. _class_AnimatedTexture_frame_106/texture: + +- :ref:`Texture` **frame_106/texture** + + .. _class_AnimatedTexture_frame_107/delay_sec: + +- :ref:`float` **frame_107/delay_sec** + + .. _class_AnimatedTexture_frame_107/texture: + +- :ref:`Texture` **frame_107/texture** + + .. _class_AnimatedTexture_frame_108/delay_sec: + +- :ref:`float` **frame_108/delay_sec** + + .. _class_AnimatedTexture_frame_108/texture: + +- :ref:`Texture` **frame_108/texture** + + .. _class_AnimatedTexture_frame_109/delay_sec: + +- :ref:`float` **frame_109/delay_sec** + + .. _class_AnimatedTexture_frame_109/texture: + +- :ref:`Texture` **frame_109/texture** + + .. _class_AnimatedTexture_frame_11/delay_sec: + +- :ref:`float` **frame_11/delay_sec** + + .. _class_AnimatedTexture_frame_11/texture: + +- :ref:`Texture` **frame_11/texture** + + .. _class_AnimatedTexture_frame_110/delay_sec: + +- :ref:`float` **frame_110/delay_sec** + + .. _class_AnimatedTexture_frame_110/texture: + +- :ref:`Texture` **frame_110/texture** + + .. _class_AnimatedTexture_frame_111/delay_sec: + +- :ref:`float` **frame_111/delay_sec** + + .. _class_AnimatedTexture_frame_111/texture: + +- :ref:`Texture` **frame_111/texture** + + .. _class_AnimatedTexture_frame_112/delay_sec: + +- :ref:`float` **frame_112/delay_sec** + + .. _class_AnimatedTexture_frame_112/texture: + +- :ref:`Texture` **frame_112/texture** + + .. _class_AnimatedTexture_frame_113/delay_sec: + +- :ref:`float` **frame_113/delay_sec** + + .. _class_AnimatedTexture_frame_113/texture: + +- :ref:`Texture` **frame_113/texture** + + .. _class_AnimatedTexture_frame_114/delay_sec: + +- :ref:`float` **frame_114/delay_sec** + + .. _class_AnimatedTexture_frame_114/texture: + +- :ref:`Texture` **frame_114/texture** + + .. _class_AnimatedTexture_frame_115/delay_sec: + +- :ref:`float` **frame_115/delay_sec** + + .. _class_AnimatedTexture_frame_115/texture: + +- :ref:`Texture` **frame_115/texture** + + .. _class_AnimatedTexture_frame_116/delay_sec: + +- :ref:`float` **frame_116/delay_sec** + + .. _class_AnimatedTexture_frame_116/texture: + +- :ref:`Texture` **frame_116/texture** + + .. _class_AnimatedTexture_frame_117/delay_sec: + +- :ref:`float` **frame_117/delay_sec** + + .. _class_AnimatedTexture_frame_117/texture: + +- :ref:`Texture` **frame_117/texture** + + .. _class_AnimatedTexture_frame_118/delay_sec: + +- :ref:`float` **frame_118/delay_sec** + + .. _class_AnimatedTexture_frame_118/texture: + +- :ref:`Texture` **frame_118/texture** + + .. _class_AnimatedTexture_frame_119/delay_sec: + +- :ref:`float` **frame_119/delay_sec** + + .. _class_AnimatedTexture_frame_119/texture: + +- :ref:`Texture` **frame_119/texture** + + .. _class_AnimatedTexture_frame_12/delay_sec: + +- :ref:`float` **frame_12/delay_sec** + + .. _class_AnimatedTexture_frame_12/texture: + +- :ref:`Texture` **frame_12/texture** + + .. _class_AnimatedTexture_frame_120/delay_sec: + +- :ref:`float` **frame_120/delay_sec** + + .. _class_AnimatedTexture_frame_120/texture: + +- :ref:`Texture` **frame_120/texture** + + .. _class_AnimatedTexture_frame_121/delay_sec: + +- :ref:`float` **frame_121/delay_sec** + + .. _class_AnimatedTexture_frame_121/texture: + +- :ref:`Texture` **frame_121/texture** + + .. _class_AnimatedTexture_frame_122/delay_sec: + +- :ref:`float` **frame_122/delay_sec** + + .. _class_AnimatedTexture_frame_122/texture: + +- :ref:`Texture` **frame_122/texture** + + .. _class_AnimatedTexture_frame_123/delay_sec: + +- :ref:`float` **frame_123/delay_sec** + + .. _class_AnimatedTexture_frame_123/texture: + +- :ref:`Texture` **frame_123/texture** + + .. _class_AnimatedTexture_frame_124/delay_sec: + +- :ref:`float` **frame_124/delay_sec** + + .. _class_AnimatedTexture_frame_124/texture: + +- :ref:`Texture` **frame_124/texture** + + .. _class_AnimatedTexture_frame_125/delay_sec: + +- :ref:`float` **frame_125/delay_sec** + + .. _class_AnimatedTexture_frame_125/texture: + +- :ref:`Texture` **frame_125/texture** + + .. _class_AnimatedTexture_frame_126/delay_sec: + +- :ref:`float` **frame_126/delay_sec** + + .. _class_AnimatedTexture_frame_126/texture: + +- :ref:`Texture` **frame_126/texture** + + .. _class_AnimatedTexture_frame_127/delay_sec: + +- :ref:`float` **frame_127/delay_sec** + + .. _class_AnimatedTexture_frame_127/texture: + +- :ref:`Texture` **frame_127/texture** + + .. _class_AnimatedTexture_frame_128/delay_sec: + +- :ref:`float` **frame_128/delay_sec** + + .. _class_AnimatedTexture_frame_128/texture: + +- :ref:`Texture` **frame_128/texture** + + .. _class_AnimatedTexture_frame_129/delay_sec: + +- :ref:`float` **frame_129/delay_sec** + + .. _class_AnimatedTexture_frame_129/texture: + +- :ref:`Texture` **frame_129/texture** + + .. _class_AnimatedTexture_frame_13/delay_sec: + +- :ref:`float` **frame_13/delay_sec** + + .. _class_AnimatedTexture_frame_13/texture: + +- :ref:`Texture` **frame_13/texture** + + .. _class_AnimatedTexture_frame_130/delay_sec: + +- :ref:`float` **frame_130/delay_sec** + + .. _class_AnimatedTexture_frame_130/texture: + +- :ref:`Texture` **frame_130/texture** + + .. _class_AnimatedTexture_frame_131/delay_sec: + +- :ref:`float` **frame_131/delay_sec** + + .. _class_AnimatedTexture_frame_131/texture: + +- :ref:`Texture` **frame_131/texture** + + .. _class_AnimatedTexture_frame_132/delay_sec: + +- :ref:`float` **frame_132/delay_sec** + + .. _class_AnimatedTexture_frame_132/texture: + +- :ref:`Texture` **frame_132/texture** + + .. _class_AnimatedTexture_frame_133/delay_sec: + +- :ref:`float` **frame_133/delay_sec** + + .. _class_AnimatedTexture_frame_133/texture: + +- :ref:`Texture` **frame_133/texture** + + .. _class_AnimatedTexture_frame_134/delay_sec: + +- :ref:`float` **frame_134/delay_sec** + + .. _class_AnimatedTexture_frame_134/texture: + +- :ref:`Texture` **frame_134/texture** + + .. _class_AnimatedTexture_frame_135/delay_sec: + +- :ref:`float` **frame_135/delay_sec** + + .. _class_AnimatedTexture_frame_135/texture: + +- :ref:`Texture` **frame_135/texture** + + .. _class_AnimatedTexture_frame_136/delay_sec: + +- :ref:`float` **frame_136/delay_sec** + + .. _class_AnimatedTexture_frame_136/texture: + +- :ref:`Texture` **frame_136/texture** + + .. _class_AnimatedTexture_frame_137/delay_sec: + +- :ref:`float` **frame_137/delay_sec** + + .. _class_AnimatedTexture_frame_137/texture: + +- :ref:`Texture` **frame_137/texture** + + .. _class_AnimatedTexture_frame_138/delay_sec: + +- :ref:`float` **frame_138/delay_sec** + + .. _class_AnimatedTexture_frame_138/texture: + +- :ref:`Texture` **frame_138/texture** + + .. _class_AnimatedTexture_frame_139/delay_sec: + +- :ref:`float` **frame_139/delay_sec** + + .. _class_AnimatedTexture_frame_139/texture: + +- :ref:`Texture` **frame_139/texture** + + .. _class_AnimatedTexture_frame_14/delay_sec: + +- :ref:`float` **frame_14/delay_sec** + + .. _class_AnimatedTexture_frame_14/texture: + +- :ref:`Texture` **frame_14/texture** + + .. _class_AnimatedTexture_frame_140/delay_sec: + +- :ref:`float` **frame_140/delay_sec** + + .. _class_AnimatedTexture_frame_140/texture: + +- :ref:`Texture` **frame_140/texture** + + .. _class_AnimatedTexture_frame_141/delay_sec: + +- :ref:`float` **frame_141/delay_sec** + + .. _class_AnimatedTexture_frame_141/texture: + +- :ref:`Texture` **frame_141/texture** + + .. _class_AnimatedTexture_frame_142/delay_sec: + +- :ref:`float` **frame_142/delay_sec** + + .. _class_AnimatedTexture_frame_142/texture: + +- :ref:`Texture` **frame_142/texture** + + .. _class_AnimatedTexture_frame_143/delay_sec: + +- :ref:`float` **frame_143/delay_sec** + + .. _class_AnimatedTexture_frame_143/texture: + +- :ref:`Texture` **frame_143/texture** + + .. _class_AnimatedTexture_frame_144/delay_sec: + +- :ref:`float` **frame_144/delay_sec** + + .. _class_AnimatedTexture_frame_144/texture: + +- :ref:`Texture` **frame_144/texture** + + .. _class_AnimatedTexture_frame_145/delay_sec: + +- :ref:`float` **frame_145/delay_sec** + + .. _class_AnimatedTexture_frame_145/texture: + +- :ref:`Texture` **frame_145/texture** + + .. _class_AnimatedTexture_frame_146/delay_sec: + +- :ref:`float` **frame_146/delay_sec** + + .. _class_AnimatedTexture_frame_146/texture: + +- :ref:`Texture` **frame_146/texture** + + .. _class_AnimatedTexture_frame_147/delay_sec: + +- :ref:`float` **frame_147/delay_sec** + + .. _class_AnimatedTexture_frame_147/texture: + +- :ref:`Texture` **frame_147/texture** + + .. _class_AnimatedTexture_frame_148/delay_sec: + +- :ref:`float` **frame_148/delay_sec** + + .. _class_AnimatedTexture_frame_148/texture: + +- :ref:`Texture` **frame_148/texture** + + .. _class_AnimatedTexture_frame_149/delay_sec: + +- :ref:`float` **frame_149/delay_sec** + + .. _class_AnimatedTexture_frame_149/texture: + +- :ref:`Texture` **frame_149/texture** + + .. _class_AnimatedTexture_frame_15/delay_sec: + +- :ref:`float` **frame_15/delay_sec** + + .. _class_AnimatedTexture_frame_15/texture: + +- :ref:`Texture` **frame_15/texture** + + .. _class_AnimatedTexture_frame_150/delay_sec: + +- :ref:`float` **frame_150/delay_sec** + + .. _class_AnimatedTexture_frame_150/texture: + +- :ref:`Texture` **frame_150/texture** + + .. _class_AnimatedTexture_frame_151/delay_sec: + +- :ref:`float` **frame_151/delay_sec** + + .. _class_AnimatedTexture_frame_151/texture: + +- :ref:`Texture` **frame_151/texture** + + .. _class_AnimatedTexture_frame_152/delay_sec: + +- :ref:`float` **frame_152/delay_sec** + + .. _class_AnimatedTexture_frame_152/texture: + +- :ref:`Texture` **frame_152/texture** + + .. _class_AnimatedTexture_frame_153/delay_sec: + +- :ref:`float` **frame_153/delay_sec** + + .. _class_AnimatedTexture_frame_153/texture: + +- :ref:`Texture` **frame_153/texture** + + .. _class_AnimatedTexture_frame_154/delay_sec: + +- :ref:`float` **frame_154/delay_sec** + + .. _class_AnimatedTexture_frame_154/texture: + +- :ref:`Texture` **frame_154/texture** + + .. _class_AnimatedTexture_frame_155/delay_sec: + +- :ref:`float` **frame_155/delay_sec** + + .. _class_AnimatedTexture_frame_155/texture: + +- :ref:`Texture` **frame_155/texture** + + .. _class_AnimatedTexture_frame_156/delay_sec: + +- :ref:`float` **frame_156/delay_sec** + + .. _class_AnimatedTexture_frame_156/texture: + +- :ref:`Texture` **frame_156/texture** + + .. _class_AnimatedTexture_frame_157/delay_sec: + +- :ref:`float` **frame_157/delay_sec** + + .. _class_AnimatedTexture_frame_157/texture: + +- :ref:`Texture` **frame_157/texture** + + .. _class_AnimatedTexture_frame_158/delay_sec: + +- :ref:`float` **frame_158/delay_sec** + + .. _class_AnimatedTexture_frame_158/texture: + +- :ref:`Texture` **frame_158/texture** + + .. _class_AnimatedTexture_frame_159/delay_sec: + +- :ref:`float` **frame_159/delay_sec** + + .. _class_AnimatedTexture_frame_159/texture: + +- :ref:`Texture` **frame_159/texture** + + .. _class_AnimatedTexture_frame_16/delay_sec: + +- :ref:`float` **frame_16/delay_sec** + + .. _class_AnimatedTexture_frame_16/texture: + +- :ref:`Texture` **frame_16/texture** + + .. _class_AnimatedTexture_frame_160/delay_sec: + +- :ref:`float` **frame_160/delay_sec** + + .. _class_AnimatedTexture_frame_160/texture: + +- :ref:`Texture` **frame_160/texture** + + .. _class_AnimatedTexture_frame_161/delay_sec: + +- :ref:`float` **frame_161/delay_sec** + + .. _class_AnimatedTexture_frame_161/texture: + +- :ref:`Texture` **frame_161/texture** + + .. _class_AnimatedTexture_frame_162/delay_sec: + +- :ref:`float` **frame_162/delay_sec** + + .. _class_AnimatedTexture_frame_162/texture: + +- :ref:`Texture` **frame_162/texture** + + .. _class_AnimatedTexture_frame_163/delay_sec: + +- :ref:`float` **frame_163/delay_sec** + + .. _class_AnimatedTexture_frame_163/texture: + +- :ref:`Texture` **frame_163/texture** + + .. _class_AnimatedTexture_frame_164/delay_sec: + +- :ref:`float` **frame_164/delay_sec** + + .. _class_AnimatedTexture_frame_164/texture: + +- :ref:`Texture` **frame_164/texture** + + .. _class_AnimatedTexture_frame_165/delay_sec: + +- :ref:`float` **frame_165/delay_sec** + + .. _class_AnimatedTexture_frame_165/texture: + +- :ref:`Texture` **frame_165/texture** + + .. _class_AnimatedTexture_frame_166/delay_sec: + +- :ref:`float` **frame_166/delay_sec** + + .. _class_AnimatedTexture_frame_166/texture: + +- :ref:`Texture` **frame_166/texture** + + .. _class_AnimatedTexture_frame_167/delay_sec: + +- :ref:`float` **frame_167/delay_sec** + + .. _class_AnimatedTexture_frame_167/texture: + +- :ref:`Texture` **frame_167/texture** + + .. _class_AnimatedTexture_frame_168/delay_sec: + +- :ref:`float` **frame_168/delay_sec** + + .. _class_AnimatedTexture_frame_168/texture: + +- :ref:`Texture` **frame_168/texture** + + .. _class_AnimatedTexture_frame_169/delay_sec: + +- :ref:`float` **frame_169/delay_sec** + + .. _class_AnimatedTexture_frame_169/texture: + +- :ref:`Texture` **frame_169/texture** + + .. _class_AnimatedTexture_frame_17/delay_sec: + +- :ref:`float` **frame_17/delay_sec** + + .. _class_AnimatedTexture_frame_17/texture: + +- :ref:`Texture` **frame_17/texture** + + .. _class_AnimatedTexture_frame_170/delay_sec: + +- :ref:`float` **frame_170/delay_sec** + + .. _class_AnimatedTexture_frame_170/texture: + +- :ref:`Texture` **frame_170/texture** + + .. _class_AnimatedTexture_frame_171/delay_sec: + +- :ref:`float` **frame_171/delay_sec** + + .. _class_AnimatedTexture_frame_171/texture: + +- :ref:`Texture` **frame_171/texture** + + .. _class_AnimatedTexture_frame_172/delay_sec: + +- :ref:`float` **frame_172/delay_sec** + + .. _class_AnimatedTexture_frame_172/texture: + +- :ref:`Texture` **frame_172/texture** + + .. _class_AnimatedTexture_frame_173/delay_sec: + +- :ref:`float` **frame_173/delay_sec** + + .. _class_AnimatedTexture_frame_173/texture: + +- :ref:`Texture` **frame_173/texture** + + .. _class_AnimatedTexture_frame_174/delay_sec: + +- :ref:`float` **frame_174/delay_sec** + + .. _class_AnimatedTexture_frame_174/texture: + +- :ref:`Texture` **frame_174/texture** + + .. _class_AnimatedTexture_frame_175/delay_sec: + +- :ref:`float` **frame_175/delay_sec** + + .. _class_AnimatedTexture_frame_175/texture: + +- :ref:`Texture` **frame_175/texture** + + .. _class_AnimatedTexture_frame_176/delay_sec: + +- :ref:`float` **frame_176/delay_sec** + + .. _class_AnimatedTexture_frame_176/texture: + +- :ref:`Texture` **frame_176/texture** + + .. _class_AnimatedTexture_frame_177/delay_sec: + +- :ref:`float` **frame_177/delay_sec** + + .. _class_AnimatedTexture_frame_177/texture: + +- :ref:`Texture` **frame_177/texture** + + .. _class_AnimatedTexture_frame_178/delay_sec: + +- :ref:`float` **frame_178/delay_sec** + + .. _class_AnimatedTexture_frame_178/texture: + +- :ref:`Texture` **frame_178/texture** + + .. _class_AnimatedTexture_frame_179/delay_sec: + +- :ref:`float` **frame_179/delay_sec** + + .. _class_AnimatedTexture_frame_179/texture: + +- :ref:`Texture` **frame_179/texture** + + .. _class_AnimatedTexture_frame_18/delay_sec: + +- :ref:`float` **frame_18/delay_sec** + + .. _class_AnimatedTexture_frame_18/texture: + +- :ref:`Texture` **frame_18/texture** + + .. _class_AnimatedTexture_frame_180/delay_sec: + +- :ref:`float` **frame_180/delay_sec** + + .. _class_AnimatedTexture_frame_180/texture: + +- :ref:`Texture` **frame_180/texture** + + .. _class_AnimatedTexture_frame_181/delay_sec: + +- :ref:`float` **frame_181/delay_sec** + + .. _class_AnimatedTexture_frame_181/texture: + +- :ref:`Texture` **frame_181/texture** + + .. _class_AnimatedTexture_frame_182/delay_sec: + +- :ref:`float` **frame_182/delay_sec** + + .. _class_AnimatedTexture_frame_182/texture: + +- :ref:`Texture` **frame_182/texture** + + .. _class_AnimatedTexture_frame_183/delay_sec: + +- :ref:`float` **frame_183/delay_sec** + + .. _class_AnimatedTexture_frame_183/texture: + +- :ref:`Texture` **frame_183/texture** + + .. _class_AnimatedTexture_frame_184/delay_sec: + +- :ref:`float` **frame_184/delay_sec** + + .. _class_AnimatedTexture_frame_184/texture: + +- :ref:`Texture` **frame_184/texture** + + .. _class_AnimatedTexture_frame_185/delay_sec: + +- :ref:`float` **frame_185/delay_sec** + + .. _class_AnimatedTexture_frame_185/texture: + +- :ref:`Texture` **frame_185/texture** + + .. _class_AnimatedTexture_frame_186/delay_sec: + +- :ref:`float` **frame_186/delay_sec** + + .. _class_AnimatedTexture_frame_186/texture: + +- :ref:`Texture` **frame_186/texture** + + .. _class_AnimatedTexture_frame_187/delay_sec: + +- :ref:`float` **frame_187/delay_sec** + + .. _class_AnimatedTexture_frame_187/texture: + +- :ref:`Texture` **frame_187/texture** + + .. _class_AnimatedTexture_frame_188/delay_sec: + +- :ref:`float` **frame_188/delay_sec** + + .. _class_AnimatedTexture_frame_188/texture: + +- :ref:`Texture` **frame_188/texture** + + .. _class_AnimatedTexture_frame_189/delay_sec: + +- :ref:`float` **frame_189/delay_sec** + + .. _class_AnimatedTexture_frame_189/texture: + +- :ref:`Texture` **frame_189/texture** + + .. _class_AnimatedTexture_frame_19/delay_sec: + +- :ref:`float` **frame_19/delay_sec** + + .. _class_AnimatedTexture_frame_19/texture: + +- :ref:`Texture` **frame_19/texture** + + .. _class_AnimatedTexture_frame_190/delay_sec: + +- :ref:`float` **frame_190/delay_sec** + + .. _class_AnimatedTexture_frame_190/texture: + +- :ref:`Texture` **frame_190/texture** + + .. _class_AnimatedTexture_frame_191/delay_sec: + +- :ref:`float` **frame_191/delay_sec** + + .. _class_AnimatedTexture_frame_191/texture: + +- :ref:`Texture` **frame_191/texture** + + .. _class_AnimatedTexture_frame_192/delay_sec: + +- :ref:`float` **frame_192/delay_sec** + + .. _class_AnimatedTexture_frame_192/texture: + +- :ref:`Texture` **frame_192/texture** + + .. _class_AnimatedTexture_frame_193/delay_sec: + +- :ref:`float` **frame_193/delay_sec** + + .. _class_AnimatedTexture_frame_193/texture: + +- :ref:`Texture` **frame_193/texture** + + .. _class_AnimatedTexture_frame_194/delay_sec: + +- :ref:`float` **frame_194/delay_sec** + + .. _class_AnimatedTexture_frame_194/texture: + +- :ref:`Texture` **frame_194/texture** + + .. _class_AnimatedTexture_frame_195/delay_sec: + +- :ref:`float` **frame_195/delay_sec** + + .. _class_AnimatedTexture_frame_195/texture: + +- :ref:`Texture` **frame_195/texture** + + .. _class_AnimatedTexture_frame_196/delay_sec: + +- :ref:`float` **frame_196/delay_sec** + + .. _class_AnimatedTexture_frame_196/texture: + +- :ref:`Texture` **frame_196/texture** + + .. _class_AnimatedTexture_frame_197/delay_sec: + +- :ref:`float` **frame_197/delay_sec** + + .. _class_AnimatedTexture_frame_197/texture: + +- :ref:`Texture` **frame_197/texture** + + .. _class_AnimatedTexture_frame_198/delay_sec: + +- :ref:`float` **frame_198/delay_sec** + + .. _class_AnimatedTexture_frame_198/texture: + +- :ref:`Texture` **frame_198/texture** + + .. _class_AnimatedTexture_frame_199/delay_sec: + +- :ref:`float` **frame_199/delay_sec** + + .. _class_AnimatedTexture_frame_199/texture: + +- :ref:`Texture` **frame_199/texture** + + .. _class_AnimatedTexture_frame_2/delay_sec: + +- :ref:`float` **frame_2/delay_sec** + + .. _class_AnimatedTexture_frame_2/texture: + +- :ref:`Texture` **frame_2/texture** + + .. _class_AnimatedTexture_frame_20/delay_sec: + +- :ref:`float` **frame_20/delay_sec** + + .. _class_AnimatedTexture_frame_20/texture: + +- :ref:`Texture` **frame_20/texture** + + .. _class_AnimatedTexture_frame_200/delay_sec: + +- :ref:`float` **frame_200/delay_sec** + + .. _class_AnimatedTexture_frame_200/texture: + +- :ref:`Texture` **frame_200/texture** + + .. _class_AnimatedTexture_frame_201/delay_sec: + +- :ref:`float` **frame_201/delay_sec** + + .. _class_AnimatedTexture_frame_201/texture: + +- :ref:`Texture` **frame_201/texture** + + .. _class_AnimatedTexture_frame_202/delay_sec: + +- :ref:`float` **frame_202/delay_sec** + + .. _class_AnimatedTexture_frame_202/texture: + +- :ref:`Texture` **frame_202/texture** + + .. _class_AnimatedTexture_frame_203/delay_sec: + +- :ref:`float` **frame_203/delay_sec** + + .. _class_AnimatedTexture_frame_203/texture: + +- :ref:`Texture` **frame_203/texture** + + .. _class_AnimatedTexture_frame_204/delay_sec: + +- :ref:`float` **frame_204/delay_sec** + + .. _class_AnimatedTexture_frame_204/texture: + +- :ref:`Texture` **frame_204/texture** + + .. _class_AnimatedTexture_frame_205/delay_sec: + +- :ref:`float` **frame_205/delay_sec** + + .. _class_AnimatedTexture_frame_205/texture: + +- :ref:`Texture` **frame_205/texture** + + .. _class_AnimatedTexture_frame_206/delay_sec: + +- :ref:`float` **frame_206/delay_sec** + + .. _class_AnimatedTexture_frame_206/texture: + +- :ref:`Texture` **frame_206/texture** + + .. _class_AnimatedTexture_frame_207/delay_sec: + +- :ref:`float` **frame_207/delay_sec** + + .. _class_AnimatedTexture_frame_207/texture: + +- :ref:`Texture` **frame_207/texture** + + .. _class_AnimatedTexture_frame_208/delay_sec: + +- :ref:`float` **frame_208/delay_sec** + + .. _class_AnimatedTexture_frame_208/texture: + +- :ref:`Texture` **frame_208/texture** + + .. _class_AnimatedTexture_frame_209/delay_sec: + +- :ref:`float` **frame_209/delay_sec** + + .. _class_AnimatedTexture_frame_209/texture: + +- :ref:`Texture` **frame_209/texture** + + .. _class_AnimatedTexture_frame_21/delay_sec: + +- :ref:`float` **frame_21/delay_sec** + + .. _class_AnimatedTexture_frame_21/texture: + +- :ref:`Texture` **frame_21/texture** + + .. _class_AnimatedTexture_frame_210/delay_sec: + +- :ref:`float` **frame_210/delay_sec** + + .. _class_AnimatedTexture_frame_210/texture: + +- :ref:`Texture` **frame_210/texture** + + .. _class_AnimatedTexture_frame_211/delay_sec: + +- :ref:`float` **frame_211/delay_sec** + + .. _class_AnimatedTexture_frame_211/texture: + +- :ref:`Texture` **frame_211/texture** + + .. _class_AnimatedTexture_frame_212/delay_sec: + +- :ref:`float` **frame_212/delay_sec** + + .. _class_AnimatedTexture_frame_212/texture: + +- :ref:`Texture` **frame_212/texture** + + .. _class_AnimatedTexture_frame_213/delay_sec: + +- :ref:`float` **frame_213/delay_sec** + + .. _class_AnimatedTexture_frame_213/texture: + +- :ref:`Texture` **frame_213/texture** + + .. _class_AnimatedTexture_frame_214/delay_sec: + +- :ref:`float` **frame_214/delay_sec** + + .. _class_AnimatedTexture_frame_214/texture: + +- :ref:`Texture` **frame_214/texture** + + .. _class_AnimatedTexture_frame_215/delay_sec: + +- :ref:`float` **frame_215/delay_sec** + + .. _class_AnimatedTexture_frame_215/texture: + +- :ref:`Texture` **frame_215/texture** + + .. _class_AnimatedTexture_frame_216/delay_sec: + +- :ref:`float` **frame_216/delay_sec** + + .. _class_AnimatedTexture_frame_216/texture: + +- :ref:`Texture` **frame_216/texture** + + .. _class_AnimatedTexture_frame_217/delay_sec: + +- :ref:`float` **frame_217/delay_sec** + + .. _class_AnimatedTexture_frame_217/texture: + +- :ref:`Texture` **frame_217/texture** + + .. _class_AnimatedTexture_frame_218/delay_sec: + +- :ref:`float` **frame_218/delay_sec** + + .. _class_AnimatedTexture_frame_218/texture: + +- :ref:`Texture` **frame_218/texture** + + .. _class_AnimatedTexture_frame_219/delay_sec: + +- :ref:`float` **frame_219/delay_sec** + + .. _class_AnimatedTexture_frame_219/texture: + +- :ref:`Texture` **frame_219/texture** + + .. _class_AnimatedTexture_frame_22/delay_sec: + +- :ref:`float` **frame_22/delay_sec** + + .. _class_AnimatedTexture_frame_22/texture: + +- :ref:`Texture` **frame_22/texture** + + .. _class_AnimatedTexture_frame_220/delay_sec: + +- :ref:`float` **frame_220/delay_sec** + + .. _class_AnimatedTexture_frame_220/texture: + +- :ref:`Texture` **frame_220/texture** + + .. _class_AnimatedTexture_frame_221/delay_sec: + +- :ref:`float` **frame_221/delay_sec** + + .. _class_AnimatedTexture_frame_221/texture: + +- :ref:`Texture` **frame_221/texture** + + .. _class_AnimatedTexture_frame_222/delay_sec: + +- :ref:`float` **frame_222/delay_sec** + + .. _class_AnimatedTexture_frame_222/texture: + +- :ref:`Texture` **frame_222/texture** + + .. _class_AnimatedTexture_frame_223/delay_sec: + +- :ref:`float` **frame_223/delay_sec** + + .. _class_AnimatedTexture_frame_223/texture: + +- :ref:`Texture` **frame_223/texture** + + .. _class_AnimatedTexture_frame_224/delay_sec: + +- :ref:`float` **frame_224/delay_sec** + + .. _class_AnimatedTexture_frame_224/texture: + +- :ref:`Texture` **frame_224/texture** + + .. _class_AnimatedTexture_frame_225/delay_sec: + +- :ref:`float` **frame_225/delay_sec** + + .. _class_AnimatedTexture_frame_225/texture: + +- :ref:`Texture` **frame_225/texture** + + .. _class_AnimatedTexture_frame_226/delay_sec: + +- :ref:`float` **frame_226/delay_sec** + + .. _class_AnimatedTexture_frame_226/texture: + +- :ref:`Texture` **frame_226/texture** + + .. _class_AnimatedTexture_frame_227/delay_sec: + +- :ref:`float` **frame_227/delay_sec** + + .. _class_AnimatedTexture_frame_227/texture: + +- :ref:`Texture` **frame_227/texture** + + .. _class_AnimatedTexture_frame_228/delay_sec: + +- :ref:`float` **frame_228/delay_sec** + + .. _class_AnimatedTexture_frame_228/texture: + +- :ref:`Texture` **frame_228/texture** + + .. _class_AnimatedTexture_frame_229/delay_sec: + +- :ref:`float` **frame_229/delay_sec** + + .. _class_AnimatedTexture_frame_229/texture: + +- :ref:`Texture` **frame_229/texture** + + .. _class_AnimatedTexture_frame_23/delay_sec: + +- :ref:`float` **frame_23/delay_sec** + + .. _class_AnimatedTexture_frame_23/texture: + +- :ref:`Texture` **frame_23/texture** + + .. _class_AnimatedTexture_frame_230/delay_sec: + +- :ref:`float` **frame_230/delay_sec** + + .. _class_AnimatedTexture_frame_230/texture: + +- :ref:`Texture` **frame_230/texture** + + .. _class_AnimatedTexture_frame_231/delay_sec: + +- :ref:`float` **frame_231/delay_sec** + + .. _class_AnimatedTexture_frame_231/texture: + +- :ref:`Texture` **frame_231/texture** + + .. _class_AnimatedTexture_frame_232/delay_sec: + +- :ref:`float` **frame_232/delay_sec** + + .. _class_AnimatedTexture_frame_232/texture: + +- :ref:`Texture` **frame_232/texture** + + .. _class_AnimatedTexture_frame_233/delay_sec: + +- :ref:`float` **frame_233/delay_sec** + + .. _class_AnimatedTexture_frame_233/texture: + +- :ref:`Texture` **frame_233/texture** + + .. _class_AnimatedTexture_frame_234/delay_sec: + +- :ref:`float` **frame_234/delay_sec** + + .. _class_AnimatedTexture_frame_234/texture: + +- :ref:`Texture` **frame_234/texture** + + .. _class_AnimatedTexture_frame_235/delay_sec: + +- :ref:`float` **frame_235/delay_sec** + + .. _class_AnimatedTexture_frame_235/texture: + +- :ref:`Texture` **frame_235/texture** + + .. _class_AnimatedTexture_frame_236/delay_sec: + +- :ref:`float` **frame_236/delay_sec** + + .. _class_AnimatedTexture_frame_236/texture: + +- :ref:`Texture` **frame_236/texture** + + .. _class_AnimatedTexture_frame_237/delay_sec: + +- :ref:`float` **frame_237/delay_sec** + + .. _class_AnimatedTexture_frame_237/texture: + +- :ref:`Texture` **frame_237/texture** + + .. _class_AnimatedTexture_frame_238/delay_sec: + +- :ref:`float` **frame_238/delay_sec** + + .. _class_AnimatedTexture_frame_238/texture: + +- :ref:`Texture` **frame_238/texture** + + .. _class_AnimatedTexture_frame_239/delay_sec: + +- :ref:`float` **frame_239/delay_sec** + + .. _class_AnimatedTexture_frame_239/texture: + +- :ref:`Texture` **frame_239/texture** + + .. _class_AnimatedTexture_frame_24/delay_sec: + +- :ref:`float` **frame_24/delay_sec** + + .. _class_AnimatedTexture_frame_24/texture: + +- :ref:`Texture` **frame_24/texture** + + .. _class_AnimatedTexture_frame_240/delay_sec: + +- :ref:`float` **frame_240/delay_sec** + + .. _class_AnimatedTexture_frame_240/texture: + +- :ref:`Texture` **frame_240/texture** + + .. _class_AnimatedTexture_frame_241/delay_sec: + +- :ref:`float` **frame_241/delay_sec** + + .. _class_AnimatedTexture_frame_241/texture: + +- :ref:`Texture` **frame_241/texture** + + .. _class_AnimatedTexture_frame_242/delay_sec: + +- :ref:`float` **frame_242/delay_sec** + + .. _class_AnimatedTexture_frame_242/texture: + +- :ref:`Texture` **frame_242/texture** + + .. _class_AnimatedTexture_frame_243/delay_sec: + +- :ref:`float` **frame_243/delay_sec** + + .. _class_AnimatedTexture_frame_243/texture: + +- :ref:`Texture` **frame_243/texture** + + .. _class_AnimatedTexture_frame_244/delay_sec: + +- :ref:`float` **frame_244/delay_sec** + + .. _class_AnimatedTexture_frame_244/texture: + +- :ref:`Texture` **frame_244/texture** + + .. _class_AnimatedTexture_frame_245/delay_sec: + +- :ref:`float` **frame_245/delay_sec** + + .. _class_AnimatedTexture_frame_245/texture: + +- :ref:`Texture` **frame_245/texture** + + .. _class_AnimatedTexture_frame_246/delay_sec: + +- :ref:`float` **frame_246/delay_sec** + + .. _class_AnimatedTexture_frame_246/texture: + +- :ref:`Texture` **frame_246/texture** + + .. _class_AnimatedTexture_frame_247/delay_sec: + +- :ref:`float` **frame_247/delay_sec** + + .. _class_AnimatedTexture_frame_247/texture: + +- :ref:`Texture` **frame_247/texture** + + .. _class_AnimatedTexture_frame_248/delay_sec: + +- :ref:`float` **frame_248/delay_sec** + + .. _class_AnimatedTexture_frame_248/texture: + +- :ref:`Texture` **frame_248/texture** + + .. _class_AnimatedTexture_frame_249/delay_sec: + +- :ref:`float` **frame_249/delay_sec** + + .. _class_AnimatedTexture_frame_249/texture: + +- :ref:`Texture` **frame_249/texture** + + .. _class_AnimatedTexture_frame_25/delay_sec: + +- :ref:`float` **frame_25/delay_sec** + + .. _class_AnimatedTexture_frame_25/texture: + +- :ref:`Texture` **frame_25/texture** + + .. _class_AnimatedTexture_frame_250/delay_sec: + +- :ref:`float` **frame_250/delay_sec** + + .. _class_AnimatedTexture_frame_250/texture: + +- :ref:`Texture` **frame_250/texture** + + .. _class_AnimatedTexture_frame_251/delay_sec: + +- :ref:`float` **frame_251/delay_sec** + + .. _class_AnimatedTexture_frame_251/texture: + +- :ref:`Texture` **frame_251/texture** + + .. _class_AnimatedTexture_frame_252/delay_sec: + +- :ref:`float` **frame_252/delay_sec** + + .. _class_AnimatedTexture_frame_252/texture: + +- :ref:`Texture` **frame_252/texture** + + .. _class_AnimatedTexture_frame_253/delay_sec: + +- :ref:`float` **frame_253/delay_sec** + + .. _class_AnimatedTexture_frame_253/texture: + +- :ref:`Texture` **frame_253/texture** + + .. _class_AnimatedTexture_frame_254/delay_sec: + +- :ref:`float` **frame_254/delay_sec** + + .. _class_AnimatedTexture_frame_254/texture: + +- :ref:`Texture` **frame_254/texture** + + .. _class_AnimatedTexture_frame_255/delay_sec: + +- :ref:`float` **frame_255/delay_sec** + + .. _class_AnimatedTexture_frame_255/texture: + +- :ref:`Texture` **frame_255/texture** + + .. _class_AnimatedTexture_frame_26/delay_sec: + +- :ref:`float` **frame_26/delay_sec** + + .. _class_AnimatedTexture_frame_26/texture: + +- :ref:`Texture` **frame_26/texture** + + .. _class_AnimatedTexture_frame_27/delay_sec: + +- :ref:`float` **frame_27/delay_sec** + + .. _class_AnimatedTexture_frame_27/texture: + +- :ref:`Texture` **frame_27/texture** + + .. _class_AnimatedTexture_frame_28/delay_sec: + +- :ref:`float` **frame_28/delay_sec** + + .. _class_AnimatedTexture_frame_28/texture: + +- :ref:`Texture` **frame_28/texture** + + .. _class_AnimatedTexture_frame_29/delay_sec: + +- :ref:`float` **frame_29/delay_sec** + + .. _class_AnimatedTexture_frame_29/texture: + +- :ref:`Texture` **frame_29/texture** + + .. _class_AnimatedTexture_frame_3/delay_sec: + +- :ref:`float` **frame_3/delay_sec** + + .. _class_AnimatedTexture_frame_3/texture: + +- :ref:`Texture` **frame_3/texture** + + .. _class_AnimatedTexture_frame_30/delay_sec: + +- :ref:`float` **frame_30/delay_sec** + + .. _class_AnimatedTexture_frame_30/texture: + +- :ref:`Texture` **frame_30/texture** + + .. _class_AnimatedTexture_frame_31/delay_sec: + +- :ref:`float` **frame_31/delay_sec** + + .. _class_AnimatedTexture_frame_31/texture: + +- :ref:`Texture` **frame_31/texture** + + .. _class_AnimatedTexture_frame_32/delay_sec: + +- :ref:`float` **frame_32/delay_sec** + + .. _class_AnimatedTexture_frame_32/texture: + +- :ref:`Texture` **frame_32/texture** + + .. _class_AnimatedTexture_frame_33/delay_sec: + +- :ref:`float` **frame_33/delay_sec** + + .. _class_AnimatedTexture_frame_33/texture: + +- :ref:`Texture` **frame_33/texture** + + .. _class_AnimatedTexture_frame_34/delay_sec: + +- :ref:`float` **frame_34/delay_sec** + + .. _class_AnimatedTexture_frame_34/texture: + +- :ref:`Texture` **frame_34/texture** + + .. _class_AnimatedTexture_frame_35/delay_sec: + +- :ref:`float` **frame_35/delay_sec** + + .. _class_AnimatedTexture_frame_35/texture: + +- :ref:`Texture` **frame_35/texture** + + .. _class_AnimatedTexture_frame_36/delay_sec: + +- :ref:`float` **frame_36/delay_sec** + + .. _class_AnimatedTexture_frame_36/texture: + +- :ref:`Texture` **frame_36/texture** + + .. _class_AnimatedTexture_frame_37/delay_sec: + +- :ref:`float` **frame_37/delay_sec** + + .. _class_AnimatedTexture_frame_37/texture: + +- :ref:`Texture` **frame_37/texture** + + .. _class_AnimatedTexture_frame_38/delay_sec: + +- :ref:`float` **frame_38/delay_sec** + + .. _class_AnimatedTexture_frame_38/texture: + +- :ref:`Texture` **frame_38/texture** + + .. _class_AnimatedTexture_frame_39/delay_sec: + +- :ref:`float` **frame_39/delay_sec** + + .. _class_AnimatedTexture_frame_39/texture: + +- :ref:`Texture` **frame_39/texture** + + .. _class_AnimatedTexture_frame_4/delay_sec: + +- :ref:`float` **frame_4/delay_sec** + + .. _class_AnimatedTexture_frame_4/texture: + +- :ref:`Texture` **frame_4/texture** + + .. _class_AnimatedTexture_frame_40/delay_sec: + +- :ref:`float` **frame_40/delay_sec** + + .. _class_AnimatedTexture_frame_40/texture: + +- :ref:`Texture` **frame_40/texture** + + .. _class_AnimatedTexture_frame_41/delay_sec: + +- :ref:`float` **frame_41/delay_sec** + + .. _class_AnimatedTexture_frame_41/texture: + +- :ref:`Texture` **frame_41/texture** + + .. _class_AnimatedTexture_frame_42/delay_sec: + +- :ref:`float` **frame_42/delay_sec** + + .. _class_AnimatedTexture_frame_42/texture: + +- :ref:`Texture` **frame_42/texture** + + .. _class_AnimatedTexture_frame_43/delay_sec: + +- :ref:`float` **frame_43/delay_sec** + + .. _class_AnimatedTexture_frame_43/texture: + +- :ref:`Texture` **frame_43/texture** + + .. _class_AnimatedTexture_frame_44/delay_sec: + +- :ref:`float` **frame_44/delay_sec** + + .. _class_AnimatedTexture_frame_44/texture: + +- :ref:`Texture` **frame_44/texture** + + .. _class_AnimatedTexture_frame_45/delay_sec: + +- :ref:`float` **frame_45/delay_sec** + + .. _class_AnimatedTexture_frame_45/texture: + +- :ref:`Texture` **frame_45/texture** + + .. _class_AnimatedTexture_frame_46/delay_sec: + +- :ref:`float` **frame_46/delay_sec** + + .. _class_AnimatedTexture_frame_46/texture: + +- :ref:`Texture` **frame_46/texture** + + .. _class_AnimatedTexture_frame_47/delay_sec: + +- :ref:`float` **frame_47/delay_sec** + + .. _class_AnimatedTexture_frame_47/texture: + +- :ref:`Texture` **frame_47/texture** + + .. _class_AnimatedTexture_frame_48/delay_sec: + +- :ref:`float` **frame_48/delay_sec** + + .. _class_AnimatedTexture_frame_48/texture: + +- :ref:`Texture` **frame_48/texture** + + .. _class_AnimatedTexture_frame_49/delay_sec: + +- :ref:`float` **frame_49/delay_sec** + + .. _class_AnimatedTexture_frame_49/texture: + +- :ref:`Texture` **frame_49/texture** + + .. _class_AnimatedTexture_frame_5/delay_sec: + +- :ref:`float` **frame_5/delay_sec** + + .. _class_AnimatedTexture_frame_5/texture: + +- :ref:`Texture` **frame_5/texture** + + .. _class_AnimatedTexture_frame_50/delay_sec: + +- :ref:`float` **frame_50/delay_sec** + + .. _class_AnimatedTexture_frame_50/texture: + +- :ref:`Texture` **frame_50/texture** + + .. _class_AnimatedTexture_frame_51/delay_sec: + +- :ref:`float` **frame_51/delay_sec** + + .. _class_AnimatedTexture_frame_51/texture: + +- :ref:`Texture` **frame_51/texture** + + .. _class_AnimatedTexture_frame_52/delay_sec: + +- :ref:`float` **frame_52/delay_sec** + + .. _class_AnimatedTexture_frame_52/texture: + +- :ref:`Texture` **frame_52/texture** + + .. _class_AnimatedTexture_frame_53/delay_sec: + +- :ref:`float` **frame_53/delay_sec** + + .. _class_AnimatedTexture_frame_53/texture: + +- :ref:`Texture` **frame_53/texture** + + .. _class_AnimatedTexture_frame_54/delay_sec: + +- :ref:`float` **frame_54/delay_sec** + + .. _class_AnimatedTexture_frame_54/texture: + +- :ref:`Texture` **frame_54/texture** + + .. _class_AnimatedTexture_frame_55/delay_sec: + +- :ref:`float` **frame_55/delay_sec** + + .. _class_AnimatedTexture_frame_55/texture: + +- :ref:`Texture` **frame_55/texture** + + .. _class_AnimatedTexture_frame_56/delay_sec: + +- :ref:`float` **frame_56/delay_sec** + + .. _class_AnimatedTexture_frame_56/texture: + +- :ref:`Texture` **frame_56/texture** + + .. _class_AnimatedTexture_frame_57/delay_sec: + +- :ref:`float` **frame_57/delay_sec** + + .. _class_AnimatedTexture_frame_57/texture: + +- :ref:`Texture` **frame_57/texture** + + .. _class_AnimatedTexture_frame_58/delay_sec: + +- :ref:`float` **frame_58/delay_sec** + + .. _class_AnimatedTexture_frame_58/texture: + +- :ref:`Texture` **frame_58/texture** + + .. _class_AnimatedTexture_frame_59/delay_sec: + +- :ref:`float` **frame_59/delay_sec** + + .. _class_AnimatedTexture_frame_59/texture: + +- :ref:`Texture` **frame_59/texture** + + .. _class_AnimatedTexture_frame_6/delay_sec: + +- :ref:`float` **frame_6/delay_sec** + + .. _class_AnimatedTexture_frame_6/texture: + +- :ref:`Texture` **frame_6/texture** + + .. _class_AnimatedTexture_frame_60/delay_sec: + +- :ref:`float` **frame_60/delay_sec** + + .. _class_AnimatedTexture_frame_60/texture: + +- :ref:`Texture` **frame_60/texture** + + .. _class_AnimatedTexture_frame_61/delay_sec: + +- :ref:`float` **frame_61/delay_sec** + + .. _class_AnimatedTexture_frame_61/texture: + +- :ref:`Texture` **frame_61/texture** + + .. _class_AnimatedTexture_frame_62/delay_sec: + +- :ref:`float` **frame_62/delay_sec** + + .. _class_AnimatedTexture_frame_62/texture: + +- :ref:`Texture` **frame_62/texture** + + .. _class_AnimatedTexture_frame_63/delay_sec: + +- :ref:`float` **frame_63/delay_sec** + + .. _class_AnimatedTexture_frame_63/texture: + +- :ref:`Texture` **frame_63/texture** + + .. _class_AnimatedTexture_frame_64/delay_sec: + +- :ref:`float` **frame_64/delay_sec** + + .. _class_AnimatedTexture_frame_64/texture: + +- :ref:`Texture` **frame_64/texture** + + .. _class_AnimatedTexture_frame_65/delay_sec: + +- :ref:`float` **frame_65/delay_sec** + + .. _class_AnimatedTexture_frame_65/texture: + +- :ref:`Texture` **frame_65/texture** + + .. _class_AnimatedTexture_frame_66/delay_sec: + +- :ref:`float` **frame_66/delay_sec** + + .. _class_AnimatedTexture_frame_66/texture: + +- :ref:`Texture` **frame_66/texture** + + .. _class_AnimatedTexture_frame_67/delay_sec: + +- :ref:`float` **frame_67/delay_sec** + + .. _class_AnimatedTexture_frame_67/texture: + +- :ref:`Texture` **frame_67/texture** + + .. _class_AnimatedTexture_frame_68/delay_sec: + +- :ref:`float` **frame_68/delay_sec** + + .. _class_AnimatedTexture_frame_68/texture: + +- :ref:`Texture` **frame_68/texture** + + .. _class_AnimatedTexture_frame_69/delay_sec: + +- :ref:`float` **frame_69/delay_sec** + + .. _class_AnimatedTexture_frame_69/texture: + +- :ref:`Texture` **frame_69/texture** + + .. _class_AnimatedTexture_frame_7/delay_sec: + +- :ref:`float` **frame_7/delay_sec** + + .. _class_AnimatedTexture_frame_7/texture: + +- :ref:`Texture` **frame_7/texture** + + .. _class_AnimatedTexture_frame_70/delay_sec: + +- :ref:`float` **frame_70/delay_sec** + + .. _class_AnimatedTexture_frame_70/texture: + +- :ref:`Texture` **frame_70/texture** + + .. _class_AnimatedTexture_frame_71/delay_sec: + +- :ref:`float` **frame_71/delay_sec** + + .. _class_AnimatedTexture_frame_71/texture: + +- :ref:`Texture` **frame_71/texture** + + .. _class_AnimatedTexture_frame_72/delay_sec: + +- :ref:`float` **frame_72/delay_sec** + + .. _class_AnimatedTexture_frame_72/texture: + +- :ref:`Texture` **frame_72/texture** + + .. _class_AnimatedTexture_frame_73/delay_sec: + +- :ref:`float` **frame_73/delay_sec** + + .. _class_AnimatedTexture_frame_73/texture: + +- :ref:`Texture` **frame_73/texture** + + .. _class_AnimatedTexture_frame_74/delay_sec: + +- :ref:`float` **frame_74/delay_sec** + + .. _class_AnimatedTexture_frame_74/texture: + +- :ref:`Texture` **frame_74/texture** + + .. _class_AnimatedTexture_frame_75/delay_sec: + +- :ref:`float` **frame_75/delay_sec** + + .. _class_AnimatedTexture_frame_75/texture: + +- :ref:`Texture` **frame_75/texture** + + .. _class_AnimatedTexture_frame_76/delay_sec: + +- :ref:`float` **frame_76/delay_sec** + + .. _class_AnimatedTexture_frame_76/texture: + +- :ref:`Texture` **frame_76/texture** + + .. _class_AnimatedTexture_frame_77/delay_sec: + +- :ref:`float` **frame_77/delay_sec** + + .. _class_AnimatedTexture_frame_77/texture: + +- :ref:`Texture` **frame_77/texture** + + .. _class_AnimatedTexture_frame_78/delay_sec: + +- :ref:`float` **frame_78/delay_sec** + + .. _class_AnimatedTexture_frame_78/texture: + +- :ref:`Texture` **frame_78/texture** + + .. _class_AnimatedTexture_frame_79/delay_sec: + +- :ref:`float` **frame_79/delay_sec** + + .. _class_AnimatedTexture_frame_79/texture: + +- :ref:`Texture` **frame_79/texture** + + .. _class_AnimatedTexture_frame_8/delay_sec: + +- :ref:`float` **frame_8/delay_sec** + + .. _class_AnimatedTexture_frame_8/texture: + +- :ref:`Texture` **frame_8/texture** + + .. _class_AnimatedTexture_frame_80/delay_sec: + +- :ref:`float` **frame_80/delay_sec** + + .. _class_AnimatedTexture_frame_80/texture: + +- :ref:`Texture` **frame_80/texture** + + .. _class_AnimatedTexture_frame_81/delay_sec: + +- :ref:`float` **frame_81/delay_sec** + + .. _class_AnimatedTexture_frame_81/texture: + +- :ref:`Texture` **frame_81/texture** + + .. _class_AnimatedTexture_frame_82/delay_sec: + +- :ref:`float` **frame_82/delay_sec** + + .. _class_AnimatedTexture_frame_82/texture: + +- :ref:`Texture` **frame_82/texture** + + .. _class_AnimatedTexture_frame_83/delay_sec: + +- :ref:`float` **frame_83/delay_sec** + + .. _class_AnimatedTexture_frame_83/texture: + +- :ref:`Texture` **frame_83/texture** + + .. _class_AnimatedTexture_frame_84/delay_sec: + +- :ref:`float` **frame_84/delay_sec** + + .. _class_AnimatedTexture_frame_84/texture: + +- :ref:`Texture` **frame_84/texture** + + .. _class_AnimatedTexture_frame_85/delay_sec: + +- :ref:`float` **frame_85/delay_sec** + + .. _class_AnimatedTexture_frame_85/texture: + +- :ref:`Texture` **frame_85/texture** + + .. _class_AnimatedTexture_frame_86/delay_sec: + +- :ref:`float` **frame_86/delay_sec** + + .. _class_AnimatedTexture_frame_86/texture: + +- :ref:`Texture` **frame_86/texture** + + .. _class_AnimatedTexture_frame_87/delay_sec: + +- :ref:`float` **frame_87/delay_sec** + + .. _class_AnimatedTexture_frame_87/texture: + +- :ref:`Texture` **frame_87/texture** + + .. _class_AnimatedTexture_frame_88/delay_sec: + +- :ref:`float` **frame_88/delay_sec** + + .. _class_AnimatedTexture_frame_88/texture: + +- :ref:`Texture` **frame_88/texture** + + .. _class_AnimatedTexture_frame_89/delay_sec: + +- :ref:`float` **frame_89/delay_sec** + + .. _class_AnimatedTexture_frame_89/texture: + +- :ref:`Texture` **frame_89/texture** + + .. _class_AnimatedTexture_frame_9/delay_sec: + +- :ref:`float` **frame_9/delay_sec** + + .. _class_AnimatedTexture_frame_9/texture: + +- :ref:`Texture` **frame_9/texture** + + .. _class_AnimatedTexture_frame_90/delay_sec: + +- :ref:`float` **frame_90/delay_sec** + + .. _class_AnimatedTexture_frame_90/texture: + +- :ref:`Texture` **frame_90/texture** + + .. _class_AnimatedTexture_frame_91/delay_sec: + +- :ref:`float` **frame_91/delay_sec** + + .. _class_AnimatedTexture_frame_91/texture: + +- :ref:`Texture` **frame_91/texture** + + .. _class_AnimatedTexture_frame_92/delay_sec: + +- :ref:`float` **frame_92/delay_sec** + + .. _class_AnimatedTexture_frame_92/texture: + +- :ref:`Texture` **frame_92/texture** + + .. _class_AnimatedTexture_frame_93/delay_sec: + +- :ref:`float` **frame_93/delay_sec** + + .. _class_AnimatedTexture_frame_93/texture: + +- :ref:`Texture` **frame_93/texture** + + .. _class_AnimatedTexture_frame_94/delay_sec: + +- :ref:`float` **frame_94/delay_sec** + + .. _class_AnimatedTexture_frame_94/texture: + +- :ref:`Texture` **frame_94/texture** + + .. _class_AnimatedTexture_frame_95/delay_sec: + +- :ref:`float` **frame_95/delay_sec** + + .. _class_AnimatedTexture_frame_95/texture: + +- :ref:`Texture` **frame_95/texture** + + .. _class_AnimatedTexture_frame_96/delay_sec: + +- :ref:`float` **frame_96/delay_sec** + + .. _class_AnimatedTexture_frame_96/texture: + +- :ref:`Texture` **frame_96/texture** + + .. _class_AnimatedTexture_frame_97/delay_sec: + +- :ref:`float` **frame_97/delay_sec** + + .. _class_AnimatedTexture_frame_97/texture: + +- :ref:`Texture` **frame_97/texture** + + .. _class_AnimatedTexture_frame_98/delay_sec: + +- :ref:`float` **frame_98/delay_sec** + + .. _class_AnimatedTexture_frame_98/texture: + +- :ref:`Texture` **frame_98/texture** + + .. _class_AnimatedTexture_frame_99/delay_sec: + +- :ref:`float` **frame_99/delay_sec** + + .. _class_AnimatedTexture_frame_99/texture: + +- :ref:`Texture` **frame_99/texture** + + .. _class_AnimatedTexture_frames: + +- :ref:`int` **frames** + + diff --git a/classes/class_animation.rst b/classes/class_animation.rst index b7fe48cdf..3cb666aac 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -19,81 +19,119 @@ Contains data used to animate everything in the engine. Member Functions ---------------- -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_track` **(** :ref:`int` track, :ref:`Animation` to_animation **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_track_count` **(** **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_track` **(** :ref:`int` idx **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key_at_position` **(** :ref:`int` idx, :ref:`float` position **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_enabled` **(** :ref:`int` idx, :ref:`bool` enabled **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** | -+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation_track_get_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_track_set_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio_track_get_key_end_offset` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio_track_get_key_start_offset` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`audio_track_get_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`audio_track_set_key_end_offset` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`audio_track_set_key_start_offset` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`audio_track_set_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bezier_track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bezier_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bezier_track_interpolate` **(** :ref:`int` track, :ref:`float` time **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bezier_track_set_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bezier_track_set_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bezier_track_set_key_value` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` value **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_track` **(** :ref:`int` track, :ref:`Animation` to_animation **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_track_count` **(** **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_track` **(** :ref:`int` idx **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key_at_position` **(** :ref:`int` idx, :ref:`float` position **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_enabled` **(** :ref:`int` idx, :ref:`bool` enabled **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_swap` **(** :ref:`int` idx, :ref:`int` with_idx **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -121,6 +159,7 @@ enum **UpdateMode** - **UPDATE_CONTINUOUS** = **0** --- Update between keyframes. - **UPDATE_DISCRETE** = **1** --- Update at the keyframes and hold the value. - **UPDATE_TRIGGER** = **2** --- Update at the keyframes. +- **UPDATE_CAPTURE** = **3** .. _enum_Animation_InterpolationType: @@ -137,6 +176,9 @@ enum **TrackType** - **TYPE_VALUE** = **0** --- Value tracks set values in node properties, but only those which can be Interpolated. - **TYPE_TRANSFORM** = **1** --- Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated. - **TYPE_METHOD** = **2** --- Method tracks call functions with given arguments per key. +- **TYPE_BEZIER** = **3** +- **TYPE_AUDIO** = **4** +- **TYPE_ANIMATION** = **5** Description @@ -146,6 +188,11 @@ An Animation resource contains data used to animate everything in the engine. An Animations are just data containers, and must be added to odes such as an :ref:`AnimationPlayer` or :ref:`AnimationTreePlayer` to be played back. +Tutorials +--------- + +- :doc:`../tutorials/animation/index` + Member Function Description --------------------------- @@ -155,6 +202,78 @@ Member Function Description Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration. +.. _class_Animation_animation_track_get_key_animation: + +- :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx **)** const + +.. _class_Animation_animation_track_insert_key: + +- :ref:`int` **animation_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** + +.. _class_Animation_animation_track_set_key_animation: + +- void **animation_track_set_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** + +.. _class_Animation_audio_track_get_key_end_offset: + +- :ref:`float` **audio_track_get_key_end_offset** **(** :ref:`int` idx, :ref:`int` key_idx **)** const + +.. _class_Animation_audio_track_get_key_start_offset: + +- :ref:`float` **audio_track_get_key_start_offset** **(** :ref:`int` idx, :ref:`int` key_idx **)** const + +.. _class_Animation_audio_track_get_key_stream: + +- :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx **)** const + +.. _class_Animation_audio_track_insert_key: + +- :ref:`int` **audio_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** + +.. _class_Animation_audio_track_set_key_end_offset: + +- void **audio_track_set_key_end_offset** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** + +.. _class_Animation_audio_track_set_key_start_offset: + +- void **audio_track_set_key_start_offset** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** + +.. _class_Animation_audio_track_set_key_stream: + +- void **audio_track_set_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** + +.. _class_Animation_bezier_track_get_key_in_handle: + +- :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const + +.. _class_Animation_bezier_track_get_key_out_handle: + +- :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const + +.. _class_Animation_bezier_track_get_key_value: + +- :ref:`float` **bezier_track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const + +.. _class_Animation_bezier_track_insert_key: + +- :ref:`int` **bezier_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** + +.. _class_Animation_bezier_track_interpolate: + +- :ref:`float` **bezier_track_interpolate** **(** :ref:`int` track, :ref:`float` time **)** const + +.. _class_Animation_bezier_track_set_key_in_handle: + +- void **bezier_track_set_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** + +.. _class_Animation_bezier_track_set_key_out_handle: + +- void **bezier_track_set_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** + +.. _class_Animation_bezier_track_set_key_value: + +- void **bezier_track_set_key_value** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` value **)** + .. _class_Animation_clear: - void **clear** **(** **)** @@ -339,7 +458,13 @@ Set the value of an existing key. - void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** -Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" +Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". + +**Example:** "character/skeleton:ankle" or "character/mesh:transform/local". + +.. _class_Animation_track_swap: + +- void **track_swap** **(** :ref:`int` idx, :ref:`int` with_idx **)** .. _class_Animation_transform_track_insert_key: diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst new file mode 100644 index 000000000..e7f0635d6 --- /dev/null +++ b/classes/class_animationnode.rst @@ -0,0 +1,146 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNode.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNode: + +AnimationNode +============= + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AnimationNodeAdd2`, :ref:`AnimationNodeAdd3`, :ref:`AnimationNodeTimeScale`, :ref:`AnimationRootNode`, :ref:`AnimationNodeBlend2`, :ref:`AnimationNodeBlend3`, :ref:`AnimationNodeTimeSeek`, :ref:`AnimationNodeOneShot`, :ref:`AnimationNodeTransition`, :ref:`AnimationNodeOutput` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_input` **(** :ref:`String` name **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_animation` **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_caption` **(** **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_input_count` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`String` name **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`has_filter` **(** **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_input` **(** :ref:`int` index **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_parameter` **(** :ref:`String` name, :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_AnimationNode_removed_from_graph: + +- **removed_from_graph** **(** **)** + +.. _class_AnimationNode_tree_changed: + +- **tree_changed** **(** **)** + + +Member Variables +---------------- + + .. _class_AnimationNode_filter_enabled: + +- :ref:`bool` **filter_enabled** + + +Enums +----- + + .. _enum_AnimationNode_FilterAction: + +enum **FilterAction** + +- **FILTER_IGNORE** = **0** +- **FILTER_PASS** = **1** +- **FILTER_STOP** = **2** +- **FILTER_BLEND** = **3** + + +Member Function Description +--------------------------- + +.. _class_AnimationNode_add_input: + +- void **add_input** **(** :ref:`String` name **)** + +.. _class_AnimationNode_blend_animation: + +- void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** + +.. _class_AnimationNode_blend_input: + +- :ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** + +.. _class_AnimationNode_blend_node: + +- :ref:`float` **blend_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** + +.. _class_AnimationNode_get_caption: + +- :ref:`String` **get_caption** **(** **)** virtual + +.. _class_AnimationNode_get_input_count: + +- :ref:`int` **get_input_count** **(** **)** const + +.. _class_AnimationNode_get_input_name: + +- :ref:`String` **get_input_name** **(** :ref:`int` input **)** + +.. _class_AnimationNode_get_parameter: + +- :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const + +.. _class_AnimationNode_has_filter: + +- :ref:`String` **has_filter** **(** **)** virtual + +.. _class_AnimationNode_is_path_filtered: + +- :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const + +.. _class_AnimationNode_process: + +- void **process** **(** :ref:`float` time, :ref:`bool` seek **)** virtual + +.. _class_AnimationNode_remove_input: + +- void **remove_input** **(** :ref:`int` index **)** + +.. _class_AnimationNode_set_filter_path: + +- void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** + +.. _class_AnimationNode_set_parameter: + +- void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** + + diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst new file mode 100644 index 000000000..6f5236db9 --- /dev/null +++ b/classes/class_animationnodeadd2.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeAdd2.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeAdd2: + +AnimationNodeAdd2 +================= + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_AnimationNodeAdd2_sync: + +- :ref:`bool` **sync** + + diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst new file mode 100644 index 000000000..1c5a7837e --- /dev/null +++ b/classes/class_animationnodeadd3.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeAdd3.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeAdd3: + +AnimationNodeAdd3 +================= + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_AnimationNodeAdd3_sync: + +- :ref:`bool` **sync** + + diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst new file mode 100644 index 000000000..a3a62b0d0 --- /dev/null +++ b/classes/class_animationnodeanimation.rst @@ -0,0 +1,41 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeAnimation.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeAnimation: + +AnimationNodeAnimation +====================== + +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_time` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_AnimationNodeAnimation_animation: + +- :ref:`String` **animation** + + +Member Function Description +--------------------------- + +.. _class_AnimationNodeAnimation_get_playback_time: + +- :ref:`float` **get_playback_time** **(** **)** const + + diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst new file mode 100644 index 000000000..040e890ca --- /dev/null +++ b/classes/class_animationnodeblend2.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeBlend2.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeBlend2: + +AnimationNodeBlend2 +=================== + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_AnimationNodeBlend2_sync: + +- :ref:`bool` **sync** + + diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst new file mode 100644 index 000000000..98b2958b2 --- /dev/null +++ b/classes/class_animationnodeblend3.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeBlend3.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeBlend3: + +AnimationNodeBlend3 +=================== + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_AnimationNodeBlend3_sync: + +- :ref:`bool` **sync** + + diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst new file mode 100644 index 000000000..d400cef2b --- /dev/null +++ b/classes/class_animationnodeblendspace1d.rst @@ -0,0 +1,89 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace1D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeBlendSpace1D: + +AnimationNodeBlendSpace1D +========================= + +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_point_count` **(** **)** const | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`float` pos **)** | ++----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_AnimationNodeBlendSpace1D_max_space: + +- :ref:`float` **max_space** + + .. _class_AnimationNodeBlendSpace1D_min_space: + +- :ref:`float` **min_space** + + .. _class_AnimationNodeBlendSpace1D_snap: + +- :ref:`float` **snap** + + .. _class_AnimationNodeBlendSpace1D_value_label: + +- :ref:`String` **value_label** + + +Member Function Description +--------------------------- + +.. _class_AnimationNodeBlendSpace1D_add_blend_point: + +- void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** + +.. _class_AnimationNodeBlendSpace1D_get_blend_point_count: + +- :ref:`int` **get_blend_point_count** **(** **)** const + +.. _class_AnimationNodeBlendSpace1D_get_blend_point_node: + +- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const + +.. _class_AnimationNodeBlendSpace1D_get_blend_point_position: + +- :ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** const + +.. _class_AnimationNodeBlendSpace1D_remove_blend_point: + +- void **remove_blend_point** **(** :ref:`int` point **)** + +.. _class_AnimationNodeBlendSpace1D_set_blend_point_node: + +- void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** + +.. _class_AnimationNodeBlendSpace1D_set_blend_point_position: + +- void **set_blend_point_position** **(** :ref:`int` point, :ref:`float` pos **)** + + diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst new file mode 100644 index 000000000..120c4d0c8 --- /dev/null +++ b/classes/class_animationnodeblendspace2d.rst @@ -0,0 +1,121 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeBlendSpace2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeBlendSpace2D: + +AnimationNodeBlendSpace2D +========================= + +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_triangle` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_point_count` **(** **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_triangle_count` **(** **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_triangle_point` **(** :ref:`int` triangle, :ref:`int` point **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_triangle` **(** :ref:`int` triangle **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`Vector2` pos **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_AnimationNodeBlendSpace2D_auto_triangles: + +- :ref:`bool` **auto_triangles** + + .. _class_AnimationNodeBlendSpace2D_max_space: + +- :ref:`Vector2` **max_space** + + .. _class_AnimationNodeBlendSpace2D_min_space: + +- :ref:`Vector2` **min_space** + + .. _class_AnimationNodeBlendSpace2D_snap: + +- :ref:`Vector2` **snap** + + .. _class_AnimationNodeBlendSpace2D_x_label: + +- :ref:`String` **x_label** + + .. _class_AnimationNodeBlendSpace2D_y_label: + +- :ref:`String` **y_label** + + +Member Function Description +--------------------------- + +.. _class_AnimationNodeBlendSpace2D_add_blend_point: + +- void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** + +.. _class_AnimationNodeBlendSpace2D_add_triangle: + +- void **add_triangle** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** + +.. _class_AnimationNodeBlendSpace2D_get_blend_point_count: + +- :ref:`int` **get_blend_point_count** **(** **)** const + +.. _class_AnimationNodeBlendSpace2D_get_blend_point_node: + +- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const + +.. _class_AnimationNodeBlendSpace2D_get_blend_point_position: + +- :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** const + +.. _class_AnimationNodeBlendSpace2D_get_triangle_count: + +- :ref:`int` **get_triangle_count** **(** **)** const + +.. _class_AnimationNodeBlendSpace2D_get_triangle_point: + +- :ref:`int` **get_triangle_point** **(** :ref:`int` triangle, :ref:`int` point **)** + +.. _class_AnimationNodeBlendSpace2D_remove_blend_point: + +- void **remove_blend_point** **(** :ref:`int` point **)** + +.. _class_AnimationNodeBlendSpace2D_remove_triangle: + +- void **remove_triangle** **(** :ref:`int` triangle **)** + +.. _class_AnimationNodeBlendSpace2D_set_blend_point_node: + +- void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** + +.. _class_AnimationNodeBlendSpace2D_set_blend_point_position: + +- void **set_blend_point_position** **(** :ref:`int` point, :ref:`Vector2` pos **)** + + diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst new file mode 100644 index 000000000..629ad27fd --- /dev/null +++ b/classes/class_animationnodeblendtree.rst @@ -0,0 +1,99 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeBlendTree.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeBlendTree: + +AnimationNodeBlendTree +====================== + +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_node` **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_node` **(** :ref:`String` input_node, :ref:`int` input_index **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` name **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_AnimationNodeBlendTree_graph_offset: + +- :ref:`Vector2` **graph_offset** + + +Numeric Constants +----------------- + +- **CONNECTION_OK** = **0** +- **CONNECTION_ERROR_NO_INPUT** = **1** +- **CONNECTION_ERROR_NO_INPUT_INDEX** = **2** +- **CONNECTION_ERROR_NO_OUTPUT** = **3** +- **CONNECTION_ERROR_SAME_NODE** = **4** +- **CONNECTION_ERROR_CONNECTION_EXISTS** = **5** + +Member Function Description +--------------------------- + +.. _class_AnimationNodeBlendTree_add_node: + +- void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** + +.. _class_AnimationNodeBlendTree_connect_node: + +- void **connect_node** **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** + +.. _class_AnimationNodeBlendTree_disconnect_node: + +- void **disconnect_node** **(** :ref:`String` input_node, :ref:`int` input_index **)** + +.. _class_AnimationNodeBlendTree_get_node: + +- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const + +.. _class_AnimationNodeBlendTree_get_node_position: + +- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const + +.. _class_AnimationNodeBlendTree_has_node: + +- :ref:`bool` **has_node** **(** :ref:`String` name **)** const + +.. _class_AnimationNodeBlendTree_remove_node: + +- void **remove_node** **(** :ref:`String` name **)** + +.. _class_AnimationNodeBlendTree_rename_node: + +- void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** + +.. _class_AnimationNodeBlendTree_set_node_position: + +- void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** + + diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst new file mode 100644 index 000000000..aa2c98589 --- /dev/null +++ b/classes/class_animationnodeoneshot.rst @@ -0,0 +1,78 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeOneShot.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeOneShot: + +AnimationNodeOneShot +==================== + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MixMode` | :ref:`get_mix_mode` **(** **)** const | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix_mode` **(** :ref:`MixMode` mode **)** | ++----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_AnimationNodeOneShot_autorestart: + +- :ref:`bool` **autorestart** + + .. _class_AnimationNodeOneShot_autorestart_delay: + +- :ref:`float` **autorestart_delay** + + .. _class_AnimationNodeOneShot_autorestart_random_delay: + +- :ref:`float` **autorestart_random_delay** + + .. _class_AnimationNodeOneShot_fadein_time: + +- :ref:`float` **fadein_time** + + .. _class_AnimationNodeOneShot_fadeout_time: + +- :ref:`float` **fadeout_time** + + .. _class_AnimationNodeOneShot_sync: + +- :ref:`bool` **sync** + + +Enums +----- + + .. _enum_AnimationNodeOneShot_MixMode: + +enum **MixMode** + +- **MIX_MODE_BLEND** = **0** +- **MIX_MODE_ADD** = **1** + + +Member Function Description +--------------------------- + +.. _class_AnimationNodeOneShot_get_mix_mode: + +- :ref:`MixMode` **get_mix_mode** **(** **)** const + +.. _class_AnimationNodeOneShot_set_mix_mode: + +- void **set_mix_mode** **(** :ref:`MixMode` mode **)** + + diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst new file mode 100644 index 000000000..7d067e481 --- /dev/null +++ b/classes/class_animationnodeoutput.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeOutput.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeOutput: + +AnimationNodeOutput +=================== + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst new file mode 100644 index 000000000..cf8810a3b --- /dev/null +++ b/classes/class_animationnodestatemachine.rst @@ -0,0 +1,159 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachine.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeStateMachine: + +AnimationNodeStateMachine +========================= + +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_transition` **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_end_node` **(** **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_start_node` **(** **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_transition_count` **(** **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_transition_from` **(** :ref:`int` idx **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_transition_to` **(** :ref:`int` idx **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_transition` **(** :ref:`String` from, :ref:`String` to **)** const | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` name **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_transition` **(** :ref:`String` from, :ref:`String` to **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_transition_by_index` **(** :ref:`int` idx **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end_node` **(** :ref:`String` name **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_graph_offset` **(** :ref:`Vector2` name **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_start_node` **(** :ref:`String` name **)** | ++----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_AnimationNodeStateMachine_add_node: + +- void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** + +.. _class_AnimationNodeStateMachine_add_transition: + +- void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** + +.. _class_AnimationNodeStateMachine_get_end_node: + +- :ref:`String` **get_end_node** **(** **)** const + +.. _class_AnimationNodeStateMachine_get_graph_offset: + +- :ref:`Vector2` **get_graph_offset** **(** **)** const + +.. _class_AnimationNodeStateMachine_get_node: + +- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const + +.. _class_AnimationNodeStateMachine_get_node_name: + +- :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const + +.. _class_AnimationNodeStateMachine_get_node_position: + +- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const + +.. _class_AnimationNodeStateMachine_get_start_node: + +- :ref:`String` **get_start_node** **(** **)** const + +.. _class_AnimationNodeStateMachine_get_transition: + +- :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const + +.. _class_AnimationNodeStateMachine_get_transition_count: + +- :ref:`int` **get_transition_count** **(** **)** const + +.. _class_AnimationNodeStateMachine_get_transition_from: + +- :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const + +.. _class_AnimationNodeStateMachine_get_transition_to: + +- :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const + +.. _class_AnimationNodeStateMachine_has_node: + +- :ref:`bool` **has_node** **(** :ref:`String` name **)** const + +.. _class_AnimationNodeStateMachine_has_transition: + +- :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const + +.. _class_AnimationNodeStateMachine_remove_node: + +- void **remove_node** **(** :ref:`String` name **)** + +.. _class_AnimationNodeStateMachine_remove_transition: + +- void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** + +.. _class_AnimationNodeStateMachine_remove_transition_by_index: + +- void **remove_transition_by_index** **(** :ref:`int` idx **)** + +.. _class_AnimationNodeStateMachine_rename_node: + +- void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** + +.. _class_AnimationNodeStateMachine_set_end_node: + +- void **set_end_node** **(** :ref:`String` name **)** + +.. _class_AnimationNodeStateMachine_set_graph_offset: + +- void **set_graph_offset** **(** :ref:`Vector2` name **)** + +.. _class_AnimationNodeStateMachine_set_node_position: + +- void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** + +.. _class_AnimationNodeStateMachine_set_start_node: + +- void **set_start_node** **(** :ref:`String` name **)** + + diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst new file mode 100644 index 000000000..97b789dee --- /dev/null +++ b/classes/class_animationnodestatemachineplayback.rst @@ -0,0 +1,63 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachinePlayback.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeStateMachinePlayback: + +AnimationNodeStateMachinePlayback +================================= + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_node` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_travel_path` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** :ref:`String` node **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`travel` **(** :ref:`String` to_node **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_AnimationNodeStateMachinePlayback_get_current_node: + +- :ref:`String` **get_current_node** **(** **)** const + +.. _class_AnimationNodeStateMachinePlayback_get_travel_path: + +- :ref:`PoolStringArray` **get_travel_path** **(** **)** const + +.. _class_AnimationNodeStateMachinePlayback_is_playing: + +- :ref:`bool` **is_playing** **(** **)** const + +.. _class_AnimationNodeStateMachinePlayback_start: + +- void **start** **(** :ref:`String` node **)** + +.. _class_AnimationNodeStateMachinePlayback_stop: + +- void **stop** **(** **)** + +.. _class_AnimationNodeStateMachinePlayback_travel: + +- void **travel** **(** :ref:`String` to_node **)** + + diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst new file mode 100644 index 000000000..7bdfca8db --- /dev/null +++ b/classes/class_animationnodestatemachinetransition.rst @@ -0,0 +1,66 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachineTransition.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeStateMachineTransition: + +AnimationNodeStateMachineTransition +=================================== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Signals +------- + +.. _class_AnimationNodeStateMachineTransition_advance_condition_changed: + +- **advance_condition_changed** **(** **)** + + +Member Variables +---------------- + + .. _class_AnimationNodeStateMachineTransition_advance_condition: + +- :ref:`String` **advance_condition** + + .. _class_AnimationNodeStateMachineTransition_auto_advance: + +- :ref:`bool` **auto_advance** + + .. _class_AnimationNodeStateMachineTransition_disabled: + +- :ref:`bool` **disabled** + + .. _class_AnimationNodeStateMachineTransition_priority: + +- :ref:`int` **priority** + + .. _class_AnimationNodeStateMachineTransition_switch_mode: + +- :ref:`SwitchMode` **switch_mode** + + .. _class_AnimationNodeStateMachineTransition_xfade_time: + +- :ref:`float` **xfade_time** + + +Enums +----- + + .. _enum_AnimationNodeStateMachineTransition_SwitchMode: + +enum **SwitchMode** + +- **SWITCH_MODE_IMMEDIATE** = **0** +- **SWITCH_MODE_SYNC** = **1** +- **SWITCH_MODE_AT_END** = **2** + + diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst new file mode 100644 index 000000000..b199199fa --- /dev/null +++ b/classes/class_animationnodetimescale.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeTimeScale.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeTimeScale: + +AnimationNodeTimeScale +====================== + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst new file mode 100644 index 000000000..f0a61ad13 --- /dev/null +++ b/classes/class_animationnodetimeseek.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeTimeSeek.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeTimeSeek: + +AnimationNodeTimeSeek +===================== + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst new file mode 100644 index 000000000..70d0bda54 --- /dev/null +++ b/classes/class_animationnodetransition.rst @@ -0,0 +1,286 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationNodeTransition.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationNodeTransition: + +AnimationNodeTransition +======================= + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_AnimationNodeTransition_input_0/auto_advance: + +- :ref:`bool` **input_0/auto_advance** + + .. _class_AnimationNodeTransition_input_0/name: + +- :ref:`String` **input_0/name** + + .. _class_AnimationNodeTransition_input_1/auto_advance: + +- :ref:`bool` **input_1/auto_advance** + + .. _class_AnimationNodeTransition_input_1/name: + +- :ref:`String` **input_1/name** + + .. _class_AnimationNodeTransition_input_10/auto_advance: + +- :ref:`bool` **input_10/auto_advance** + + .. _class_AnimationNodeTransition_input_10/name: + +- :ref:`String` **input_10/name** + + .. _class_AnimationNodeTransition_input_11/auto_advance: + +- :ref:`bool` **input_11/auto_advance** + + .. _class_AnimationNodeTransition_input_11/name: + +- :ref:`String` **input_11/name** + + .. _class_AnimationNodeTransition_input_12/auto_advance: + +- :ref:`bool` **input_12/auto_advance** + + .. _class_AnimationNodeTransition_input_12/name: + +- :ref:`String` **input_12/name** + + .. _class_AnimationNodeTransition_input_13/auto_advance: + +- :ref:`bool` **input_13/auto_advance** + + .. _class_AnimationNodeTransition_input_13/name: + +- :ref:`String` **input_13/name** + + .. _class_AnimationNodeTransition_input_14/auto_advance: + +- :ref:`bool` **input_14/auto_advance** + + .. _class_AnimationNodeTransition_input_14/name: + +- :ref:`String` **input_14/name** + + .. _class_AnimationNodeTransition_input_15/auto_advance: + +- :ref:`bool` **input_15/auto_advance** + + .. _class_AnimationNodeTransition_input_15/name: + +- :ref:`String` **input_15/name** + + .. _class_AnimationNodeTransition_input_16/auto_advance: + +- :ref:`bool` **input_16/auto_advance** + + .. _class_AnimationNodeTransition_input_16/name: + +- :ref:`String` **input_16/name** + + .. _class_AnimationNodeTransition_input_17/auto_advance: + +- :ref:`bool` **input_17/auto_advance** + + .. _class_AnimationNodeTransition_input_17/name: + +- :ref:`String` **input_17/name** + + .. _class_AnimationNodeTransition_input_18/auto_advance: + +- :ref:`bool` **input_18/auto_advance** + + .. _class_AnimationNodeTransition_input_18/name: + +- :ref:`String` **input_18/name** + + .. _class_AnimationNodeTransition_input_19/auto_advance: + +- :ref:`bool` **input_19/auto_advance** + + .. _class_AnimationNodeTransition_input_19/name: + +- :ref:`String` **input_19/name** + + .. _class_AnimationNodeTransition_input_2/auto_advance: + +- :ref:`bool` **input_2/auto_advance** + + .. _class_AnimationNodeTransition_input_2/name: + +- :ref:`String` **input_2/name** + + .. _class_AnimationNodeTransition_input_20/auto_advance: + +- :ref:`bool` **input_20/auto_advance** + + .. _class_AnimationNodeTransition_input_20/name: + +- :ref:`String` **input_20/name** + + .. _class_AnimationNodeTransition_input_21/auto_advance: + +- :ref:`bool` **input_21/auto_advance** + + .. _class_AnimationNodeTransition_input_21/name: + +- :ref:`String` **input_21/name** + + .. _class_AnimationNodeTransition_input_22/auto_advance: + +- :ref:`bool` **input_22/auto_advance** + + .. _class_AnimationNodeTransition_input_22/name: + +- :ref:`String` **input_22/name** + + .. _class_AnimationNodeTransition_input_23/auto_advance: + +- :ref:`bool` **input_23/auto_advance** + + .. _class_AnimationNodeTransition_input_23/name: + +- :ref:`String` **input_23/name** + + .. _class_AnimationNodeTransition_input_24/auto_advance: + +- :ref:`bool` **input_24/auto_advance** + + .. _class_AnimationNodeTransition_input_24/name: + +- :ref:`String` **input_24/name** + + .. _class_AnimationNodeTransition_input_25/auto_advance: + +- :ref:`bool` **input_25/auto_advance** + + .. _class_AnimationNodeTransition_input_25/name: + +- :ref:`String` **input_25/name** + + .. _class_AnimationNodeTransition_input_26/auto_advance: + +- :ref:`bool` **input_26/auto_advance** + + .. _class_AnimationNodeTransition_input_26/name: + +- :ref:`String` **input_26/name** + + .. _class_AnimationNodeTransition_input_27/auto_advance: + +- :ref:`bool` **input_27/auto_advance** + + .. _class_AnimationNodeTransition_input_27/name: + +- :ref:`String` **input_27/name** + + .. _class_AnimationNodeTransition_input_28/auto_advance: + +- :ref:`bool` **input_28/auto_advance** + + .. _class_AnimationNodeTransition_input_28/name: + +- :ref:`String` **input_28/name** + + .. _class_AnimationNodeTransition_input_29/auto_advance: + +- :ref:`bool` **input_29/auto_advance** + + .. _class_AnimationNodeTransition_input_29/name: + +- :ref:`String` **input_29/name** + + .. _class_AnimationNodeTransition_input_3/auto_advance: + +- :ref:`bool` **input_3/auto_advance** + + .. _class_AnimationNodeTransition_input_3/name: + +- :ref:`String` **input_3/name** + + .. _class_AnimationNodeTransition_input_30/auto_advance: + +- :ref:`bool` **input_30/auto_advance** + + .. _class_AnimationNodeTransition_input_30/name: + +- :ref:`String` **input_30/name** + + .. _class_AnimationNodeTransition_input_31/auto_advance: + +- :ref:`bool` **input_31/auto_advance** + + .. _class_AnimationNodeTransition_input_31/name: + +- :ref:`String` **input_31/name** + + .. _class_AnimationNodeTransition_input_4/auto_advance: + +- :ref:`bool` **input_4/auto_advance** + + .. _class_AnimationNodeTransition_input_4/name: + +- :ref:`String` **input_4/name** + + .. _class_AnimationNodeTransition_input_5/auto_advance: + +- :ref:`bool` **input_5/auto_advance** + + .. _class_AnimationNodeTransition_input_5/name: + +- :ref:`String` **input_5/name** + + .. _class_AnimationNodeTransition_input_6/auto_advance: + +- :ref:`bool` **input_6/auto_advance** + + .. _class_AnimationNodeTransition_input_6/name: + +- :ref:`String` **input_6/name** + + .. _class_AnimationNodeTransition_input_7/auto_advance: + +- :ref:`bool` **input_7/auto_advance** + + .. _class_AnimationNodeTransition_input_7/name: + +- :ref:`String` **input_7/name** + + .. _class_AnimationNodeTransition_input_8/auto_advance: + +- :ref:`bool` **input_8/auto_advance** + + .. _class_AnimationNodeTransition_input_8/name: + +- :ref:`String` **input_8/name** + + .. _class_AnimationNodeTransition_input_9/auto_advance: + +- :ref:`bool` **input_9/auto_advance** + + .. _class_AnimationNodeTransition_input_9/name: + +- :ref:`String` **input_9/name** + + .. _class_AnimationNodeTransition_input_count: + +- :ref:`int` **input_count** + + .. _class_AnimationNodeTransition_xfade_time: + +- :ref:`float` **xfade_time** + + diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 62ed59a5e..823f54001 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -84,6 +84,10 @@ Notifies when an animation finished playing. Notifies when an animation starts playing. +.. _class_AnimationPlayer_caches_cleared: + +- **caches_cleared** **(** **)** + Member Variables ---------------- @@ -138,6 +142,7 @@ enum **AnimationProcessMode** - **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. - **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. +- **ANIMATION_PROCESS_MANUAL** = **2** --- Do not process animation. Use the 'advance' method to process the animation manually. Description @@ -145,6 +150,12 @@ Description An animation player is used for general purpose playback of :ref:`Animation` resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. +Tutorials +--------- + +- :doc:`../getting_started/step_by_step/animations` +- :doc:`../tutorials/animation/index` + Member Function Description --------------------------- diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst new file mode 100644 index 000000000..88696a525 --- /dev/null +++ b/classes/class_animationrootnode.rst @@ -0,0 +1,20 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationRootNode.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationRootNode: + +AnimationRootNode +================= + +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AnimationNodeAnimation`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendTree` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_animationtrackeditplugin.rst new file mode 100644 index 000000000..fa504aef3 --- /dev/null +++ b/classes/class_animationtrackeditplugin.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationTrackEditPlugin.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationTrackEditPlugin: + +AnimationTrackEditPlugin +======================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst new file mode 100644 index 000000000..481016077 --- /dev/null +++ b/classes/class_animationtree.rst @@ -0,0 +1,81 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AnimationTree.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AnimationTree: + +AnimationTree +============= + +**Inherits:** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_root_motion_transform` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_parameter` **(** :ref:`String` old_name, :ref:`String` new_name **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_AnimationTree_active: + +- :ref:`bool` **active** + + .. _class_AnimationTree_anim_player: + +- :ref:`NodePath` **anim_player** + + .. _class_AnimationTree_process_mode: + +- :ref:`AnimationProcessMode` **process_mode** + + .. _class_AnimationTree_root_motion_track: + +- :ref:`NodePath` **root_motion_track** + + .. _class_AnimationTree_tree_root: + +- :ref:`AnimationNode` **tree_root** + + +Enums +----- + + .. _enum_AnimationTree_AnimationProcessMode: + +enum **AnimationProcessMode** + +- **ANIMATION_PROCESS_PHYSICS** = **0** +- **ANIMATION_PROCESS_IDLE** = **1** +- **ANIMATION_PROCESS_MANUAL** = **2** + + +Member Function Description +--------------------------- + +.. _class_AnimationTree_advance: + +- void **advance** **(** :ref:`float` delta **)** + +.. _class_AnimationTree_get_root_motion_transform: + +- :ref:`Transform` **get_root_motion_transform** **(** **)** const + +.. _class_AnimationTree_rename_parameter: + +- void **rename_parameter** **(** :ref:`String` old_name, :ref:`String` new_name **)** + + diff --git a/classes/class_array.rst b/classes/class_array.rst index ef8d2d328..457e81ef8 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -90,7 +90,18 @@ Member Functions Description ----------- -Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference. +Generic array, contains several elements of any type, accessible by a numerical index starting at 0. Negative indices can be used to count from the back, like in Python (-1 is the last element, -2 the second to last, etc.). Example: + +:: + + var array = ["One", 2, 3, "Four"] + print(array[0]) # One + print(array[2]) # 3 + print(array[-1]) # Four + array[2] = "Three" + print(array[-2]) # Three + +Arrays are always passed by reference. Member Function Description --------------------------- @@ -306,7 +317,9 @@ Sort the array using natural order. - void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** -Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. +Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. + +**Note:** you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. :: diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 0479be9c0..4bf705a7f 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -22,7 +22,7 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97792 **)** | +| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_geometry` **(** **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -34,10 +34,12 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_surface_count` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform` arg0, :ref:`float` arg1 **)** | +| :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform` transform, :ref:`float` texel_size **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`regen_normalmaps` **(** **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | @@ -72,7 +74,7 @@ Member Variables .. _class_ArrayMesh_custom_aabb: -- :ref:`AABB` **custom_aabb** +- :ref:`AABB` **custom_aabb** - An overriding bounding box for this mesh. Numeric Constants @@ -125,7 +127,7 @@ Member Function Description .. _class_ArrayMesh_add_surface_from_arrays: -- void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97792 **)** +- void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** Creates a new surface. @@ -141,18 +143,26 @@ Godot uses clockwise winding order for front faces of triangle primitive modes. - void **center_geometry** **(** **)** +Centers the geometry. + .. _class_ArrayMesh_clear_blend_shapes: - void **clear_blend_shapes** **(** **)** +Remove all blend shapes from this ``ArrayMesh``. + .. _class_ArrayMesh_get_blend_shape_count: - :ref:`int` **get_blend_shape_count** **(** **)** const +Returns the number of blend shapes that the ``ArrayMesh`` holds. + .. _class_ArrayMesh_get_blend_shape_name: - :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const +Returns the name of the blend shape at this index. + .. _class_ArrayMesh_get_surface_count: - :ref:`int` **get_surface_count** **(** **)** const @@ -161,12 +171,22 @@ Return the amount of surfaces that the ``ArrayMesh`` holds. .. _class_ArrayMesh_lightmap_unwrap: -- :ref:`Error` **lightmap_unwrap** **(** :ref:`Transform` arg0, :ref:`float` arg1 **)** +- :ref:`Error` **lightmap_unwrap** **(** :ref:`Transform` transform, :ref:`float` texel_size **)** + +Will perform a UV unwrap on the ``ArrayMesh`` to prepare the mesh for lightmapping. .. _class_ArrayMesh_regen_normalmaps: - void **regen_normalmaps** **(** **)** +Will regenerate normal maps for the ``ArrayMesh``. + +.. _class_ArrayMesh_surface_find_by_name: + +- :ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** const + +Return the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned. + .. _class_ArrayMesh_surface_get_array_index_len: - :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const @@ -183,10 +203,14 @@ Return the length in vertices of the vertex array in the requested surface (see - :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** const +Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see :ref:`add_surface_from_arrays`). + .. _class_ArrayMesh_surface_get_blend_shape_arrays: - :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const +Returns the blend shape arrays for the requested surface. + .. _class_ArrayMesh_surface_get_format: - :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const @@ -203,6 +227,8 @@ Return a :ref:`Material` in a given surface. Surface is rendered - :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const +Get the name assigned to this surface. + .. _class_ArrayMesh_surface_get_primitive_type: - :ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const @@ -219,11 +245,13 @@ Remove a surface at position surf_idx, shifting greater surfaces one surf_idx sl - void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** +Set a :ref:`Material` for a given surface. Surface will be rendered using this material. + .. _class_ArrayMesh_surface_set_name: - void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** -Set a :ref:`Material` for a given surface. Surface will be rendered using this material. +Set a name for a given surface. .. _class_ArrayMesh_surface_update_region: diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 9cb61ff84..80801c57d 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -9,7 +9,7 @@ AudioEffect **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPhaser` +**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectRecord`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPhaser` **Category:** Core diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index 3f079411a..786ff5eaf 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -43,7 +43,5 @@ Band 9 : 8000 Hz Band 10 : 16000 Hz - - See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`. diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index fd8c42443..91acb5558 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -65,7 +65,5 @@ Band 20 : 16000 Hz Band 21 : 22000 Hz - - See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ10`. diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index c30d624a9..54cf19d9b 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -35,7 +35,5 @@ Band 5 : 3200 Hz Band 6 : 10000 Hz - - See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ10`, :ref:`AudioEffectEQ21`. diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst new file mode 100644 index 000000000..6e635175a --- /dev/null +++ b/classes/class_audioeffectrecord.rst @@ -0,0 +1,53 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AudioEffectRecord.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AudioEffectRecord: + +AudioEffectRecord +================= + +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStreamSample` | :ref:`get_recording` **(** **)** const | ++----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_recording_active` **(** **)** const | ++----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_recording_active` **(** :ref:`bool` record **)** | ++----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_AudioEffectRecord_format: + +- :ref:`Format` **format** + + +Member Function Description +--------------------------- + +.. _class_AudioEffectRecord_get_recording: + +- :ref:`AudioStreamSample` **get_recording** **(** **)** const + +.. _class_AudioEffectRecord_is_recording_active: + +- :ref:`bool` **is_recording_active** **(** **)** const + +.. _class_AudioEffectRecord_set_recording_active: + +- void **set_recording_active** **(** :ref:`bool` record **)** + + diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 0b22babc2..cc5976cb7 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -24,6 +24,12 @@ Member Functions +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`capture_get_device` **(** **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`capture_get_device_list` **(** **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`capture_set_device` **(** :ref:`String` name **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bus_count` **(** **)** const | @@ -86,7 +92,7 @@ Member Functions +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`String` arg0 **)** | +| 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 **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -120,6 +126,11 @@ Description AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. +Tutorials +--------- + +- :doc:`../tutorials/audio/audio_buses` + Member Function Description --------------------------- @@ -135,6 +146,18 @@ Adds a bus at ``at_position``. Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ``at_position``. +.. _class_AudioServer_capture_get_device: + +- :ref:`String` **capture_get_device** **(** **)** + +.. _class_AudioServer_capture_get_device_list: + +- :ref:`Array` **capture_get_device_list** **(** **)** + +.. _class_AudioServer_capture_set_device: + +- void **capture_set_device** **(** :ref:`String` name **)** + .. _class_AudioServer_generate_bus_layout: - :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const @@ -319,7 +342,7 @@ Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. .. _class_AudioServer_set_device: -- void **set_device** **(** :ref:`String` arg0 **)** +- void **set_device** **(** :ref:`String` device **)** .. _class_AudioServer_swap_bus_effects: diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index eabef70cf..68545ca57 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -9,7 +9,7 @@ AudioStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioStreamSample`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamOGGVorbis` +**Inherited By:** :ref:`AudioStreamMicrophone`, :ref:`AudioStreamSample`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamOGGVorbis` **Category:** Core @@ -30,6 +30,11 @@ Description Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a Sample. +Tutorials +--------- + +- :doc:`../tutorials/audio/audio_streams` + Member Function Description --------------------------- @@ -37,4 +42,6 @@ Member Function Description - :ref:`float` **get_length** **(** **)** const +Returns the length of the audio stream in seconds. + diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst new file mode 100644 index 000000000..9b0c6788b --- /dev/null +++ b/classes/class_audiostreammicrophone.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AudioStreamMicrophone.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AudioStreamMicrophone: + +AudioStreamMicrophone +===================== + +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 04980d234..3abc61c77 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -66,6 +66,10 @@ Member Variables - :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. + .. _class_AudioStreamPlayer_stream_paused: + +- :ref:`bool` **stream_paused** + .. _class_AudioStreamPlayer_volume_db: - :ref:`float` **volume_db** - Volume of sound, in dB. @@ -88,6 +92,12 @@ Description Plays background audio. +Tutorials +--------- + +- :doc:`../learning/features/audio/index` +- :doc:`../tutorials/audio/audio_streams` + Member Function Description --------------------------- @@ -95,7 +105,7 @@ Member Function Description - :ref:`float` **get_playback_position** **(** **)** -Returns the position in the :ref:`AudioStream`. +Returns the position in the :ref:`AudioStream` in seconds. .. _class_AudioStreamPlayer_play: diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 21dc60470..c874ef3d7 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -74,6 +74,10 @@ Member Variables - :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. + .. _class_AudioStreamPlayer2D_stream_paused: + +- :ref:`bool` **stream_paused** + .. _class_AudioStreamPlayer2D_volume_db: - :ref:`float` **volume_db** - Base volume without dampening. @@ -84,6 +88,12 @@ Description Plays audio that dampens with distance from screen center. +Tutorials +--------- + +- :doc:`../learning/features/audio/index` +- :doc:`../tutorials/audio/audio_streams` + Member Function Description --------------------------- diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 77f6085e3..9155ec652 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -106,6 +106,10 @@ Member Variables - :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. + .. _class_AudioStreamPlayer3D_stream_paused: + +- :ref:`bool` **stream_paused** + .. _class_AudioStreamPlayer3D_unit_db: - :ref:`float` **unit_db** - Base sound level unaffected by dampening, in dB. @@ -147,6 +151,12 @@ Description Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. +Tutorials +--------- + +- :doc:`../learning/features/audio/index` +- :doc:`../tutorials/audio/audio_streams` + Member Function Description --------------------------- diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index ad8f07a26..ccbeba140 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -16,6 +16,13 @@ Brief Description Plays audio. +Member Functions +---------------- + ++-------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_to_wav` **(** :ref:`String` path **)** | ++-------+------------------------------------------------------------------------------------------------------+ + Member Variables ---------------- @@ -73,3 +80,11 @@ Description Plays audio, can loop. +Member Function Description +--------------------------- + +.. _class_AudioStreamSample_save_to_wav: + +- void **save_to_wav** **(** :ref:`String` path **)** + + diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index ef5e68d22..6905adfa1 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -14,7 +14,7 @@ BackBufferCopy Brief Description ----------------- -Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction. +Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with ``SCREEN_TEXTURE`` in the ``texture()`` function. Member Variables ---------------- @@ -43,5 +43,5 @@ enum **CopyMode** Description ----------- -Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction. +Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Use ``SCREEN_TEXTURE`` in the ``texture()`` function to access the buffer. diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index 820cce194..c839aac8f 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -14,7 +14,7 @@ BakedLightmap Brief Description ----------------- - +Prerendered indirect light map for a scene. Member Functions ---------------- @@ -30,7 +30,7 @@ Member Variables .. _class_BakedLightmap_bake_cell_size: -- :ref:`float` **bake_cell_size** +- :ref:`float` **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. .. _class_BakedLightmap_bake_energy: @@ -38,15 +38,15 @@ Member Variables .. _class_BakedLightmap_bake_extents: -- :ref:`Vector3` **bake_extents** +- :ref:`Vector3` **bake_extents** - Size of affected area. .. _class_BakedLightmap_bake_hdr: -- :ref:`bool` **bake_hdr** +- :ref:`bool` **bake_hdr** - If ``true`` lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. .. _class_BakedLightmap_bake_mode: -- :ref:`BakeMode` **bake_mode** +- :ref:`BakeMode` **bake_mode** - Lightmapping mode. See :ref:`BakeMode`. .. _class_BakedLightmap_bake_propagation: @@ -54,19 +54,19 @@ Member Variables .. _class_BakedLightmap_bake_quality: -- :ref:`BakeQuality` **bake_quality** +- :ref:`BakeQuality` **bake_quality** - Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. .. _class_BakedLightmap_capture_cell_size: -- :ref:`float` **capture_cell_size** +- :ref:`float` **capture_cell_size** - Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. .. _class_BakedLightmap_image_path: -- :ref:`String` **image_path** +- :ref:`String` **image_path** - Location where lightmaps will be saved. .. _class_BakedLightmap_light_data: -- :ref:`BakedLightmapData` **light_data** +- :ref:`BakedLightmapData` **light_data** - The calculated light data. Enums @@ -76,9 +76,9 @@ Enums enum **BakeQuality** -- **BAKE_QUALITY_LOW** = **0** -- **BAKE_QUALITY_MEDIUM** = **1** -- **BAKE_QUALITY_HIGH** = **2** +- **BAKE_QUALITY_LOW** = **0** --- Lowest bake quality mode. Fastest to calculate. +- **BAKE_QUALITY_MEDIUM** = **1** --- Default bake quality mode. +- **BAKE_QUALITY_HIGH** = **2** --- Highest bake quality mode. Takes longer to calculate. .. _enum_BakedLightmap_BakeError: @@ -94,10 +94,20 @@ enum **BakeError** enum **BakeMode** -- **BAKE_MODE_CONE_TRACE** = **0** -- **BAKE_MODE_RAY_TRACE** = **1** +- **BAKE_MODE_CONE_TRACE** = **0** --- Less precise but faster bake mode. +- **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake. +Description +----------- + +Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the :ref:`GIProbe` approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time. + +Tutorials +--------- + +- :doc:`../tutorials/3d/baked_lightmaps` + Member Function Description --------------------------- diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 2ce95332f..0a93fde5b 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -80,6 +80,12 @@ Description For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). +Tutorials +--------- + +- :doc:`../tutorials/3d/using_transforms` +- :doc:`../tutorials/math/rotations` + Member Function Description --------------------------- diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index c1e0e035c..7e2b8a57e 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -30,6 +30,10 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_true_bit_count` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`grow_mask` **(** :ref:`int` pixels, :ref:`Rect2` rect **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`opaque_to_polygons` **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | @@ -73,6 +77,14 @@ Returns bitmap's dimensions. Returns the amount of bitmap elements that are set to true. +.. _class_BitMap_grow_mask: + +- void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** + +.. _class_BitMap_opaque_to_polygons: + +- :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const + .. _class_BitMap_set_bit: - void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 2debce2ff..5a68c31ed 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -26,6 +26,8 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** const | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_current` **(** **)** | @@ -38,6 +40,8 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask_bit` **(** :ref:`int` layer, :ref:`bool` enable **)** | ++------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | @@ -143,6 +147,10 @@ If this is the current Camera, remove it from being current. If ``enable_next`` Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node` transform. +.. _class_Camera_get_cull_mask_bit: + +- :ref:`bool` **get_cull_mask_bit** **(** :ref:`int` layer **)** const + .. _class_Camera_is_position_behind: - :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** const @@ -179,6 +187,10 @@ Returns a normal vector in worldspace, that is the result of projecting a point Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. +.. _class_Camera_set_cull_mask_bit: + +- void **set_cull_mask_bit** **(** :ref:`int` layer, :ref:`bool` enable **)** + .. _class_Camera_set_orthogonal: - void **set_orthogonal** **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index f369cdc80..ea1f2f7a2 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -212,6 +212,12 @@ Canvas items can also be hidden (hiding also their subtree). They provide many m Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed. +Tutorials +--------- + +- :doc:`../tutorials/2d/2d_transforms` +- :doc:`../tutorials/2d/custom_drawing_in_2d` + Member Function Description --------------------------- diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 3015e3f4c..b44909cb6 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -62,6 +62,12 @@ Description Canvas drawing layer. :ref:`CanvasItem` nodes that are direct or indirect children of a ``CanvasLayer`` will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a ``CanvasLayer`` with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). +Tutorials +--------- + +- :doc:`../tutorials/2d/2d_transforms` +- :doc:`../tutorials/2d/canvas_layers` + Member Function Description --------------------------- diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index c081ab3b9..b8ea832b6 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -42,6 +42,11 @@ Description Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area` to give it a detection shape, or add it to a :ref:`PhysicsBody` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + Member Function Description --------------------------- diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 3e114cc36..0b8a28f61 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -37,3 +37,8 @@ Description Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D` to give it a detection shape, or add it to a :ref:`PhysicsBody2D` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + diff --git a/classes/class_color.rst b/classes/class_color.rst index 861cd2592..3785181e5 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -18,13 +18,13 @@ Member Functions ---------------- +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | +| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -42,12 +42,20 @@ Member Functions +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_abgr32` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_abgr64` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_argb32` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_argb64` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_rgba32` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_rgba64` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -97,48 +105,167 @@ Member Variables - :ref:`float` **v** - Value (0 to 1) +Numeric Constants +----------------- + +- **gray** = **Color( 0.75, 0.75, 0.75, 1 )** +- **aliceblue** = **Color( 0.94, 0.97, 1, 1 )** +- **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )** +- **aqua** = **Color( 0, 1, 1, 1 )** +- **aquamarine** = **Color( 0.5, 1, 0.83, 1 )** +- **azure** = **Color( 0.94, 1, 1, 1 )** +- **beige** = **Color( 0.96, 0.96, 0.86, 1 )** +- **bisque** = **Color( 1, 0.89, 0.77, 1 )** +- **black** = **Color( 0, 0, 0, 1 )** +- **blanchedalmond** = **Color( 1, 0.92, 0.8, 1 )** +- **blue** = **Color( 0, 0, 1, 1 )** +- **blueviolet** = **Color( 0.54, 0.17, 0.89, 1 )** +- **brown** = **Color( 0.65, 0.16, 0.16, 1 )** +- **burlywood** = **Color( 0.87, 0.72, 0.53, 1 )** +- **cadetblue** = **Color( 0.37, 0.62, 0.63, 1 )** +- **chartreuse** = **Color( 0.5, 1, 0, 1 )** +- **chocolate** = **Color( 0.82, 0.41, 0.12, 1 )** +- **coral** = **Color( 1, 0.5, 0.31, 1 )** +- **cornflower** = **Color( 0.39, 0.58, 0.93, 1 )** +- **cornsilk** = **Color( 1, 0.97, 0.86, 1 )** +- **crimson** = **Color( 0.86, 0.08, 0.24, 1 )** +- **cyan** = **Color( 0, 1, 1, 1 )** +- **darkblue** = **Color( 0, 0, 0.55, 1 )** +- **darkcyan** = **Color( 0, 0.55, 0.55, 1 )** +- **darkgoldenrod** = **Color( 0.72, 0.53, 0.04, 1 )** +- **darkgray** = **Color( 0.66, 0.66, 0.66, 1 )** +- **darkgreen** = **Color( 0, 0.39, 0, 1 )** +- **darkkhaki** = **Color( 0.74, 0.72, 0.42, 1 )** +- **darkmagenta** = **Color( 0.55, 0, 0.55, 1 )** +- **darkolivegreen** = **Color( 0.33, 0.42, 0.18, 1 )** +- **darkorange** = **Color( 1, 0.55, 0, 1 )** +- **darkorchid** = **Color( 0.6, 0.2, 0.8, 1 )** +- **darkred** = **Color( 0.55, 0, 0, 1 )** +- **darksalmon** = **Color( 0.91, 0.59, 0.48, 1 )** +- **darkseagreen** = **Color( 0.56, 0.74, 0.56, 1 )** +- **darkslateblue** = **Color( 0.28, 0.24, 0.55, 1 )** +- **darkslategray** = **Color( 0.18, 0.31, 0.31, 1 )** +- **darkturquoise** = **Color( 0, 0.81, 0.82, 1 )** +- **darkviolet** = **Color( 0.58, 0, 0.83, 1 )** +- **deeppink** = **Color( 1, 0.08, 0.58, 1 )** +- **deepskyblue** = **Color( 0, 0.75, 1, 1 )** +- **dimgray** = **Color( 0.41, 0.41, 0.41, 1 )** +- **dodgerblue** = **Color( 0.12, 0.56, 1, 1 )** +- **firebrick** = **Color( 0.7, 0.13, 0.13, 1 )** +- **floralwhite** = **Color( 1, 0.98, 0.94, 1 )** +- **forestgreen** = **Color( 0.13, 0.55, 0.13, 1 )** +- **fuchsia** = **Color( 1, 0, 1, 1 )** +- **gainsboro** = **Color( 0.86, 0.86, 0.86, 1 )** +- **ghostwhite** = **Color( 0.97, 0.97, 1, 1 )** +- **gold** = **Color( 1, 0.84, 0, 1 )** +- **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )** +- **green** = **Color( 0, 1, 0, 1 )** +- **greenyellow** = **Color( 0.68, 1, 0.18, 1 )** +- **honeydew** = **Color( 0.94, 1, 0.94, 1 )** +- **hotpink** = **Color( 1, 0.41, 0.71, 1 )** +- **indianred** = **Color( 0.8, 0.36, 0.36, 1 )** +- **indigo** = **Color( 0.29, 0, 0.51, 1 )** +- **ivory** = **Color( 1, 1, 0.94, 1 )** +- **khaki** = **Color( 0.94, 0.9, 0.55, 1 )** +- **lavender** = **Color( 0.9, 0.9, 0.98, 1 )** +- **lavenderblush** = **Color( 1, 0.94, 0.96, 1 )** +- **lawngreen** = **Color( 0.49, 0.99, 0, 1 )** +- **lemonchiffon** = **Color( 1, 0.98, 0.8, 1 )** +- **lightblue** = **Color( 0.68, 0.85, 0.9, 1 )** +- **lightcoral** = **Color( 0.94, 0.5, 0.5, 1 )** +- **lightcyan** = **Color( 0.88, 1, 1, 1 )** +- **lightgoldenrod** = **Color( 0.98, 0.98, 0.82, 1 )** +- **lightgray** = **Color( 0.83, 0.83, 0.83, 1 )** +- **lightgreen** = **Color( 0.56, 0.93, 0.56, 1 )** +- **lightpink** = **Color( 1, 0.71, 0.76, 1 )** +- **lightsalmon** = **Color( 1, 0.63, 0.48, 1 )** +- **lightseagreen** = **Color( 0.13, 0.7, 0.67, 1 )** +- **lightskyblue** = **Color( 0.53, 0.81, 0.98, 1 )** +- **lightslategray** = **Color( 0.47, 0.53, 0.6, 1 )** +- **lightsteelblue** = **Color( 0.69, 0.77, 0.87, 1 )** +- **lightyellow** = **Color( 1, 1, 0.88, 1 )** +- **lime** = **Color( 0, 1, 0, 1 )** +- **limegreen** = **Color( 0.2, 0.8, 0.2, 1 )** +- **linen** = **Color( 0.98, 0.94, 0.9, 1 )** +- **magenta** = **Color( 1, 0, 1, 1 )** +- **maroon** = **Color( 0.69, 0.19, 0.38, 1 )** +- **mediumaquamarine** = **Color( 0.4, 0.8, 0.67, 1 )** +- **mediumblue** = **Color( 0, 0, 0.8, 1 )** +- **mediumorchid** = **Color( 0.73, 0.33, 0.83, 1 )** +- **mediumpurple** = **Color( 0.58, 0.44, 0.86, 1 )** +- **mediumseagreen** = **Color( 0.24, 0.7, 0.44, 1 )** +- **mediumslateblue** = **Color( 0.48, 0.41, 0.93, 1 )** +- **mediumspringgreen** = **Color( 0, 0.98, 0.6, 1 )** +- **mediumturquoise** = **Color( 0.28, 0.82, 0.8, 1 )** +- **mediumvioletred** = **Color( 0.78, 0.08, 0.52, 1 )** +- **midnightblue** = **Color( 0.1, 0.1, 0.44, 1 )** +- **mintcream** = **Color( 0.96, 1, 0.98, 1 )** +- **mistyrose** = **Color( 1, 0.89, 0.88, 1 )** +- **moccasin** = **Color( 1, 0.89, 0.71, 1 )** +- **navajowhite** = **Color( 1, 0.87, 0.68, 1 )** +- **navyblue** = **Color( 0, 0, 0.5, 1 )** +- **oldlace** = **Color( 0.99, 0.96, 0.9, 1 )** +- **olive** = **Color( 0.5, 0.5, 0, 1 )** +- **olivedrab** = **Color( 0.42, 0.56, 0.14, 1 )** +- **orange** = **Color( 1, 0.65, 0, 1 )** +- **orangered** = **Color( 1, 0.27, 0, 1 )** +- **orchid** = **Color( 0.85, 0.44, 0.84, 1 )** +- **palegoldenrod** = **Color( 0.93, 0.91, 0.67, 1 )** +- **palegreen** = **Color( 0.6, 0.98, 0.6, 1 )** +- **paleturquoise** = **Color( 0.69, 0.93, 0.93, 1 )** +- **palevioletred** = **Color( 0.86, 0.44, 0.58, 1 )** +- **papayawhip** = **Color( 1, 0.94, 0.84, 1 )** +- **peachpuff** = **Color( 1, 0.85, 0.73, 1 )** +- **peru** = **Color( 0.8, 0.52, 0.25, 1 )** +- **pink** = **Color( 1, 0.75, 0.8, 1 )** +- **plum** = **Color( 0.87, 0.63, 0.87, 1 )** +- **powderblue** = **Color( 0.69, 0.88, 0.9, 1 )** +- **purple** = **Color( 0.63, 0.13, 0.94, 1 )** +- **rebeccapurple** = **Color( 0.4, 0.2, 0.6, 1 )** +- **red** = **Color( 1, 0, 0, 1 )** +- **rosybrown** = **Color( 0.74, 0.56, 0.56, 1 )** +- **royalblue** = **Color( 0.25, 0.41, 0.88, 1 )** +- **saddlebrown** = **Color( 0.55, 0.27, 0.07, 1 )** +- **salmon** = **Color( 0.98, 0.5, 0.45, 1 )** +- **sandybrown** = **Color( 0.96, 0.64, 0.38, 1 )** +- **seagreen** = **Color( 0.18, 0.55, 0.34, 1 )** +- **seashell** = **Color( 1, 0.96, 0.93, 1 )** +- **sienna** = **Color( 0.63, 0.32, 0.18, 1 )** +- **silver** = **Color( 0.75, 0.75, 0.75, 1 )** +- **skyblue** = **Color( 0.53, 0.81, 0.92, 1 )** +- **slateblue** = **Color( 0.42, 0.35, 0.8, 1 )** +- **slategray** = **Color( 0.44, 0.5, 0.56, 1 )** +- **snow** = **Color( 1, 0.98, 0.98, 1 )** +- **springgreen** = **Color( 0, 1, 0.5, 1 )** +- **steelblue** = **Color( 0.27, 0.51, 0.71, 1 )** +- **tan** = **Color( 0.82, 0.71, 0.55, 1 )** +- **teal** = **Color( 0, 0.5, 0.5, 1 )** +- **thistle** = **Color( 0.85, 0.75, 0.85, 1 )** +- **tomato** = **Color( 1, 0.39, 0.28, 1 )** +- **turquoise** = **Color( 0.25, 0.88, 0.82, 1 )** +- **violet** = **Color( 0.93, 0.51, 0.93, 1 )** +- **webgray** = **Color( 0.5, 0.5, 0.5, 1 )** +- **webgreen** = **Color( 0, 0.5, 0, 1 )** +- **webmaroon** = **Color( 0.5, 0, 0, 1 )** +- **webpurple** = **Color( 0.5, 0, 0.5, 1 )** +- **wheat** = **Color( 0.96, 0.87, 0.7, 1 )** +- **white** = **Color( 1, 1, 1, 1 )** +- **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )** +- **yellow** = **Color( 1, 1, 0, 1 )** +- **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )** + Description ----------- A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate(color)) may accept values > 1. -You can also create a color from standardised color names with :ref:`@GDScript.ColorN`. +You can also create a color from standardised color names with Color.ColorN (e.g. Color.green) or :ref:`@GDScript.ColorN`. Member Function Description --------------------------- .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** - -Constructs a color from an RGBA profile using values between 0 and 1 (float). - -:: - - var c = Color(0.2, 1.0, .7, .8) # a color of an RGBA(51, 255, 178, 204) - -.. _class_Color_Color: - -- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** - -Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1. - -:: - - var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255) - -.. _class_Color_Color: - -- :ref:`Color` **Color** **(** :ref:`int` from **)** - -Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). - -:: - - var c = Color(274) # a color of an RGBA(0, 0, 1, 18) - -.. _class_Color_Color: - - :ref:`Color` **Color** **(** :ref:`String` from **)** Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN`. @@ -161,6 +288,36 @@ The following string formats are supported: var c3 = Color("#b2d90a") # RGB format with '#' var c4 = Color("b2d90a") # RGB format +.. _class_Color_Color: + +- :ref:`Color` **Color** **(** :ref:`int` from **)** + +Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). + +:: + + var c = Color(274) # a color of an RGBA(0, 0, 1, 18) + +.. _class_Color_Color: + +- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** + +Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1. + +:: + + var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255) + +.. _class_Color_Color: + +- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** + +Constructs a color from an RGBA profile using values between 0 and 1 (float). + +:: + + var c = Color(0.2, 1.0, .7, .8) # a color of an RGBA(51, 255, 178, 204) + .. _class_Color_blend: - :ref:`Color` **blend** **(** :ref:`Color` over **)** @@ -252,16 +409,49 @@ Returns the color of the linear interpolation with another color. The value t is var c2 = Color(0.0, 1.0, 0.0) var li_c = c1.linear_interpolate(c2, 0.5) # a color of an RGBA(128, 128, 0, 255) -.. _class_Color_to_argb32: +.. _class_Color_to_abgr32: -- :ref:`int` **to_argb32** **(** **)** +- :ref:`int` **to_abgr32** **(** **)** -Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). More compatible with DirectX. +Returns the color's 32-bit integer in ABGR format (each byte represents a component of the ABGR profile). ABGR is the reversed version of the default format. :: var c = Color(1, .5, .2) - print(str(c.to_32())) # prints 4294934323 + print(c.to_abgr32()) # Prints 4281565439 + +.. _class_Color_to_abgr64: + +- :ref:`int` **to_abgr64** **(** **)** + +Returns the color's 64-bit integer in ABGR format (each word represents a component of the ABGR profile). ABGR is the reversed version of the default format. + +:: + + var c = Color(1, .5, .2) + print(c.to_abgr64()) # Prints -225178692812801 + +.. _class_Color_to_argb32: + +- :ref:`int` **to_argb32** **(** **)** + +Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). ARGB is more compatible with DirectX. + +:: + + var c = Color(1, .5, .2) + print(c.to_argb32()) # Prints 4294934323 + +.. _class_Color_to_argb64: + +- :ref:`int` **to_argb64** **(** **)** + +Returns the color's 64-bit integer in ARGB format (each word represents a component of the ARGB profile). ARGB is more compatible with DirectX. + +:: + + var c = Color(1, .5, .2) + print(c.to_argb64()) # Prints -2147470541 .. _class_Color_to_html: @@ -281,13 +471,22 @@ Optionally flag 'false' to not include alpha in hexadecimal string. - :ref:`int` **to_rgba32** **(** **)** -Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). +Returns the color's 32-bit integer in RGBA format (each byte represents a component of the RGBA profile). RGBA is the format that Godot uses by default. :: var c = Color(1, .5, .2) - print(str(c.to_32())) # prints 4294934323 + print(c.to_rgba32()) # Prints 4286526463 -*This is same as :ref:`to_argb32` but may be changed later to support RGBA format instead*. +.. _class_Color_to_rgba64: + +- :ref:`int` **to_rgba64** **(** **)** + +Returns the color's 64-bit integer in RGBA format (each word represents a component of the RGBA profile). RGBA is the format that Godot uses by default. + +:: + + var c = Color(1, .5, .2) + print(c.to_rgba64()) # Prints -140736629309441 diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 730994bff..bded321bf 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -40,19 +40,23 @@ Member Variables - :ref:`Color` **color** - The currently selected color. + .. _class_ColorPicker_deferred_mode: + +- :ref:`bool` **deferred_mode** - If ``true`` the color will apply only after the user releases the mouse button, otherwise it will apply immediatly even in mouse motion event (which can cause performance issues). + .. _class_ColorPicker_edit_alpha: -- :ref:`bool` **edit_alpha** - If ``true``, shows an alpha channel slider (transparency). +- :ref:`bool` **edit_alpha** - If ``true`` shows an alpha channel slider (transparency). .. _class_ColorPicker_raw_mode: -- :ref:`bool` **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). +- :ref:`bool` **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). Description ----------- -This is a simple color picker :ref:`Control`. It's useful for selecting a color from an RGB/RGBA colorspace. +:ref:`Control` node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace. Member Function Description --------------------------- @@ -61,6 +65,6 @@ Member Function Description - void **add_preset** **(** :ref:`Color` color **)** -Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. +Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for *this* color picker. diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index b8dd0ab47..c50dd68aa 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -19,11 +19,11 @@ Button that pops out a :ref:`ColorPicker`. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------+ -| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------+ -| :ref:`PopupPanel` | :ref:`get_popup` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------+ +| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------+ +| :ref:`PopupPanel` | :ref:`get_popup` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------+ Signals ------- @@ -54,7 +54,7 @@ Member Variables Description ----------- -Encapsulates a :ref:`ColorPicker` making it accesible by pressing a button, pressing the button will toggle the :ref:`ColorPicker` visibility +Encapsulates a :ref:`ColorPicker` making it accesible by pressing a button. Pressing the button will toggle the :ref:`ColorPicker` visibility. Member Function Description --------------------------- @@ -63,12 +63,12 @@ Member Function Description - :ref:`ColorPicker` **get_picker** **(** **)** -Returns the ``ColorPicker`` that this ``ColorPickerButton`` toggles. +Returns the :ref:`ColorPicker` that this node toggles. .. _class_ColorPickerButton_get_popup: -- :ref:`PopupPanel` **get_popup** **(** **)** const +- :ref:`PopupPanel` **get_popup** **(** **)** -Returns the control's :ref:`PopupPanel` which allows you to connect to Popup Signals. This allows you to handle events when the ColorPicker is shown or hidden. +Returns the control's :ref:`PopupPanel` which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 3e95a0e28..a03e3abe8 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -14,22 +14,22 @@ ColorRect Brief Description ----------------- -Colored rect for canvas. +Colored rectangle. Member Variables ---------------- .. _class_ColorRect_color: -- :ref:`Color` **color** - The color to fill the ``ColorRect``. +- :ref:`Color` **color** - The fill color. :: - $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect node's color to red + $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red. Description ----------- -An object that is represented on the canvas as a rect with color. :ref:`Color` is used to set or get color info for the rect. +Displays a colored rectangle. diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 2464fae26..dd229a4eb 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -123,6 +123,6 @@ Saves the contents of the ConfigFile object to the file specified as a parameter - void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** -Assigns a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. +Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 02ceda894..f311bccfe 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -9,7 +9,7 @@ ConfirmationDialog **Inherits:** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`EditorFileDialog`, :ref:`FileDialog` +**Inherited By:** :ref:`ScriptCreateDialog`, :ref:`EditorFileDialog`, :ref:`FileDialog` **Category:** Core diff --git a/classes/class_container.rst b/classes/class_container.rst index 5937f545c..98a2c4c72 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -9,7 +9,7 @@ Container **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer`, :ref:`EditorProperty` +**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`TabContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer`, :ref:`EditorProperty` **Category:** Core diff --git a/classes/class_control.rst b/classes/class_control.rst index 7d9b7cc5b..57ac04f5d 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -9,23 +9,27 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` +**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` **Category:** Core Brief Description ----------------- -All User Interface nodes inherit from Control. Features anchors and margins to adapt its position and size to its parent. +All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent. Member Functions ---------------- ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_clips_input` **(** **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`_make_custom_tooltip` **(** :ref:`String` for_text **)** virtual | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`accept_event` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | @@ -282,6 +286,8 @@ Margins are often controlled by one or multiple parent :ref:`Container` **mouse_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. +**Note:** On Linux, shapes may vary depending on the cursor theme of the system. + .. _class_Control_mouse_filter: - :ref:`MouseFilter` **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. Use one of the ``MOUSE_FILTER_*`` constants. See the constants to learn what each does. @@ -339,11 +345,11 @@ Numeric Constants ----------------- - **NOTIFICATION_RESIZED** = **40** --- Sent when the node changes size. Use :ref:`rect_size` to get the new size. -- **NOTIFICATION_MOUSE_ENTER** = **41** --- Sent when the mouse pointer enters the node's ``Rect`` area. -- **NOTIFICATION_MOUSE_EXIT** = **42** --- Sent when the mouse pointer exits the node's ``Rect`` area. +- **NOTIFICATION_MOUSE_ENTER** = **41** --- Sent when the mouse pointer enters the node. +- **NOTIFICATION_MOUSE_EXIT** = **42** --- Sent when the mouse pointer exits the node. - **NOTIFICATION_FOCUS_ENTER** = **43** --- Sent when the node grabs focus. - **NOTIFICATION_FOCUS_EXIT** = **44** --- Sent when the node loses focus. -- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the ``Control``. Happens when you call one of the ``add_*_override`` +- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the control. Happens when you call one of the ``add_*_override`` - **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. - **NOTIFICATION_SCROLL_BEGIN** = **47** - **NOTIFICATION_SCROLL_END** = **48** @@ -358,7 +364,7 @@ enum **SizeFlags** - **SIZE_FILL** = **1** --- Tells the parent :ref:`Container` to expand the bounds of this node to fill all the available space without pushing any other node. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - **SIZE_EXPAND** = **2** --- Tells the parent :ref:`Container` to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See :ref:`size_flags_stretch_ratio`. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - **SIZE_EXPAND_FILL** = **3** --- Sets the node's size flags to both fill and expand. See the 2 constants above for more information. -- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the ``Control`` based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. .. _enum_Control_CursorShape: @@ -387,9 +393,9 @@ enum **CursorShape** enum **FocusMode** -- **FOCUS_NONE** = **0** --- The node cannot grab focus. Use with :ref:`set_focus_mode`. -- **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with :ref:`set_focus_mode`. -- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`set_focus_mode`. +- **FOCUS_NONE** = **0** --- The node cannot grab focus. Use with :ref:`focus_mode`. +- **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with :ref:`focus_mode`. +- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode`. .. _enum_Control_GrowDirection: @@ -462,14 +468,24 @@ Set :ref:`mouse_filter` to MOUSE_FILTER_IGNORE to te :ref:`Theme` resources change the Control's appearance. If you change the :ref:`Theme` on a ``Control`` node, it affects all of its children. To override some of the theme's parameters, call one of the ``add_*_override`` methods, like :ref:`add_font_override`. You can override the theme with the inspector. +Tutorials +--------- + +- :doc:`../tutorials/gui/index` +- :doc:`../tutorials/2d/custom_drawing_in_2d` + Member Function Description --------------------------- +.. _class_Control__clips_input: + +- :ref:`bool` **_clips_input** **(** **)** virtual + .. _class_Control__get_minimum_size: - :ref:`Vector2` **_get_minimum_size** **(** **)** virtual -Returns the minimum size this Control can shrink to. The node can never be smaller than this minimum size. +Returns the minimum size for this control. See :ref:`rect_min_size`. .. _class_Control__gui_input: @@ -479,6 +495,10 @@ The node's parent forwards input events to this method. Use it to process and ac Replaces Godot 2's ``_input_event``. +.. _class_Control__make_custom_tooltip: + +- :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** virtual + .. _class_Control_accept_event: - void **accept_event** **(** **)** @@ -566,6 +586,8 @@ The methods :ref:`can_drop_data` and :ref:`drop_dat - :ref:`Vector2` **get_begin** **(** **)** const +Returns :ref:`margin_left` and :ref:`margin_top`. See also :ref:`rect_position`. + .. _class_Control_get_color: - :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const @@ -582,7 +604,7 @@ The methods :ref:`can_drop_data` and :ref:`drop_dat - :ref:`CursorShape` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const -Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR_*`` constants. +Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. .. _class_Control_get_drag_data: @@ -605,13 +627,13 @@ A preview that will follow the mouse that should represent the data can be set w - :ref:`Vector2` **get_end** **(** **)** const -Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). +Returns :ref:`margin_right` and :ref:`margin_bottom`. .. _class_Control_get_focus_owner: - :ref:`Control` **get_focus_owner** **(** **)** const -Return which control is owning the keyboard focus, or null if no one. +Returns the control that has the keyboard focus or ``null`` if none. .. _class_Control_get_font: @@ -621,7 +643,7 @@ Return which control is owning the keyboard focus, or null if no one. - :ref:`Rect2` **get_global_rect** **(** **)** const -Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_position`, :ref:`get_size`). +Returns the position and size of the control relative to the top-left corner of the screen. See :ref:`rect_position` and :ref:`rect_size`. .. _class_Control_get_icon: @@ -631,27 +653,31 @@ Return position and size of the Control, relative to the top-left corner of the - :ref:`Vector2` **get_minimum_size** **(** **)** const -Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. +Returns the minimum size for this control. See :ref:`rect_min_size`. .. _class_Control_get_parent_area_size: - :ref:`Vector2` **get_parent_area_size** **(** **)** const +Returns the width/height occupied in the parent control. + .. _class_Control_get_parent_control: - :ref:`Control` **get_parent_control** **(** **)** const +Returns the parent control node. + .. _class_Control_get_rect: - :ref:`Rect2` **get_rect** **(** **)** const -Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see :ref:`get_position`, :ref:`get_size`). +Returns the position and size of the control relative to the top-left corner of the parent Control. See :ref:`rect_position` and :ref:`rect_size`. .. _class_Control_get_rotation: - :ref:`float` **get_rotation** **(** **)** const -Return the rotation (in radians) +Returns the rotation (in radians). .. _class_Control_get_stylebox: @@ -661,7 +687,7 @@ Return the rotation (in radians) - :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const -Return the tooltip, which will appear when the cursor is resting over this control. +Returns the tooltip, which will appear when the cursor is resting over this control. .. _class_Control_grab_click_focus: @@ -693,7 +719,7 @@ Steal the focus from another control and become the focused control (see :ref:`s - :ref:`bool` **has_focus** **(** **)** const -Return whether the Control is the current focused control (see :ref:`set_focus_mode`). +Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. .. _class_Control_has_font: @@ -735,7 +761,7 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m - void **release_focus** **(** **)** -Give up the focus, no other control will be able to receive keyboard input. +Give up the focus. No other control will be able to receive keyboard input. .. _class_Control_set_anchor: @@ -757,7 +783,7 @@ Give up the focus, no other control will be able to receive keyboard input. - void **set_begin** **(** :ref:`Vector2` position **)** -Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). +Sets :ref:`margin_left` and :ref:`margin_top` at the same time. .. _class_Control_set_drag_forwarding: @@ -800,7 +826,7 @@ Shows the given control at the mouse pointer. A good time to call this method is - void **set_end** **(** :ref:`Vector2` position **)** -Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref:`set_margin`). +Sets :ref:`margin_right` and :ref:`margin_bottom` at the same time. .. _class_Control_set_margins_preset: @@ -810,13 +836,13 @@ Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref - void **set_rotation** **(** :ref:`float` radians **)** -Set the rotation (in radians). +Sets the rotation (in radians). .. _class_Control_show_modal: - void **show_modal** **(** :ref:`bool` exclusive=false **)** -Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. +Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. .. _class_Control_warp_mouse: diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst new file mode 100644 index 000000000..0f9d7915c --- /dev/null +++ b/classes/class_cpuparticles.rst @@ -0,0 +1,330 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the CPUParticles.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_CPUParticles: + +CPUParticles +============ + +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++-------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | ++-------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++-------+------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_CPUParticles_amount: + +- :ref:`int` **amount** + + .. _class_CPUParticles_angle: + +- :ref:`float` **angle** + + .. _class_CPUParticles_angle_curve: + +- :ref:`Curve` **angle_curve** + + .. _class_CPUParticles_angle_random: + +- :ref:`float` **angle_random** + + .. _class_CPUParticles_angular_velocity: + +- :ref:`float` **angular_velocity** + + .. _class_CPUParticles_angular_velocity_curve: + +- :ref:`Curve` **angular_velocity_curve** + + .. _class_CPUParticles_angular_velocity_random: + +- :ref:`float` **angular_velocity_random** + + .. _class_CPUParticles_anim_loop: + +- :ref:`bool` **anim_loop** + + .. _class_CPUParticles_anim_offset: + +- :ref:`float` **anim_offset** + + .. _class_CPUParticles_anim_offset_curve: + +- :ref:`Curve` **anim_offset_curve** + + .. _class_CPUParticles_anim_offset_random: + +- :ref:`float` **anim_offset_random** + + .. _class_CPUParticles_anim_speed: + +- :ref:`float` **anim_speed** + + .. _class_CPUParticles_anim_speed_curve: + +- :ref:`Curve` **anim_speed_curve** + + .. _class_CPUParticles_anim_speed_random: + +- :ref:`float` **anim_speed_random** + + .. _class_CPUParticles_color: + +- :ref:`Color` **color** + + .. _class_CPUParticles_color_ramp: + +- :ref:`Gradient` **color_ramp** + + .. _class_CPUParticles_damping: + +- :ref:`float` **damping** + + .. _class_CPUParticles_damping_curve: + +- :ref:`Curve` **damping_curve** + + .. _class_CPUParticles_damping_random: + +- :ref:`float` **damping_random** + + .. _class_CPUParticles_draw_order: + +- :ref:`DrawOrder` **draw_order** + + .. _class_CPUParticles_emission_box_extents: + +- :ref:`Vector3` **emission_box_extents** + + .. _class_CPUParticles_emission_colors: + +- :ref:`PoolColorArray` **emission_colors** + + .. _class_CPUParticles_emission_normals: + +- :ref:`PoolVector3Array` **emission_normals** + + .. _class_CPUParticles_emission_points: + +- :ref:`PoolVector3Array` **emission_points** + + .. _class_CPUParticles_emission_shape: + +- :ref:`EmissionShape` **emission_shape** + + .. _class_CPUParticles_emission_sphere_radius: + +- :ref:`float` **emission_sphere_radius** + + .. _class_CPUParticles_emitting: + +- :ref:`bool` **emitting** + + .. _class_CPUParticles_explosiveness: + +- :ref:`float` **explosiveness** + + .. _class_CPUParticles_fixed_fps: + +- :ref:`int` **fixed_fps** + + .. _class_CPUParticles_flag_align_y: + +- :ref:`bool` **flag_align_y** + + .. _class_CPUParticles_flag_disable_z: + +- :ref:`bool` **flag_disable_z** + + .. _class_CPUParticles_flag_rotate_y: + +- :ref:`bool` **flag_rotate_y** + + .. _class_CPUParticles_flatness: + +- :ref:`float` **flatness** + + .. _class_CPUParticles_fract_delta: + +- :ref:`bool` **fract_delta** + + .. _class_CPUParticles_gravity: + +- :ref:`Vector3` **gravity** + + .. _class_CPUParticles_hue_variation: + +- :ref:`float` **hue_variation** + + .. _class_CPUParticles_hue_variation_curve: + +- :ref:`Curve` **hue_variation_curve** + + .. _class_CPUParticles_hue_variation_random: + +- :ref:`float` **hue_variation_random** + + .. _class_CPUParticles_initial_velocity: + +- :ref:`float` **initial_velocity** + + .. _class_CPUParticles_initial_velocity_random: + +- :ref:`float` **initial_velocity_random** + + .. _class_CPUParticles_lifetime: + +- :ref:`float` **lifetime** + + .. _class_CPUParticles_linear_accel: + +- :ref:`float` **linear_accel** + + .. _class_CPUParticles_linear_accel_curve: + +- :ref:`Curve` **linear_accel_curve** + + .. _class_CPUParticles_linear_accel_random: + +- :ref:`float` **linear_accel_random** + + .. _class_CPUParticles_local_coords: + +- :ref:`bool` **local_coords** + + .. _class_CPUParticles_mesh: + +- :ref:`Mesh` **mesh** + + .. _class_CPUParticles_one_shot: + +- :ref:`bool` **one_shot** + + .. _class_CPUParticles_preprocess: + +- :ref:`float` **preprocess** + + .. _class_CPUParticles_radial_accel: + +- :ref:`float` **radial_accel** + + .. _class_CPUParticles_radial_accel_curve: + +- :ref:`Curve` **radial_accel_curve** + + .. _class_CPUParticles_radial_accel_random: + +- :ref:`float` **radial_accel_random** + + .. _class_CPUParticles_randomness: + +- :ref:`float` **randomness** + + .. _class_CPUParticles_scale: + +- :ref:`float` **scale** + + .. _class_CPUParticles_scale_curve: + +- :ref:`Curve` **scale_curve** + + .. _class_CPUParticles_scale_random: + +- :ref:`float` **scale_random** + + .. _class_CPUParticles_speed_scale: + +- :ref:`float` **speed_scale** + + .. _class_CPUParticles_spread: + +- :ref:`float` **spread** + + .. _class_CPUParticles_tangential_accel: + +- :ref:`float` **tangential_accel** + + .. _class_CPUParticles_tangential_accel_curve: + +- :ref:`Curve` **tangential_accel_curve** + + .. _class_CPUParticles_tangential_accel_random: + +- :ref:`float` **tangential_accel_random** + + +Enums +----- + + .. _enum_CPUParticles_Flags: + +enum **Flags** + +- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** +- **FLAG_ROTATE_Y** = **1** +- **FLAG_MAX** = **4** + + .. _enum_CPUParticles_Parameter: + +enum **Parameter** + +- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** +- **PARAM_ANGULAR_VELOCITY** = **1** +- **PARAM_LINEAR_ACCEL** = **2** +- **PARAM_RADIAL_ACCEL** = **3** +- **PARAM_TANGENTIAL_ACCEL** = **4** +- **PARAM_DAMPING** = **5** +- **PARAM_ANGLE** = **6** +- **PARAM_SCALE** = **7** +- **PARAM_HUE_VARIATION** = **8** +- **PARAM_ANIM_SPEED** = **9** +- **PARAM_ANIM_OFFSET** = **10** +- **PARAM_MAX** = **11** + + .. _enum_CPUParticles_EmissionShape: + +enum **EmissionShape** + +- **EMISSION_SHAPE_POINT** = **0** +- **EMISSION_SHAPE_SPHERE** = **1** +- **EMISSION_SHAPE_BOX** = **2** +- **EMISSION_SHAPE_POINTS** = **3** +- **EMISSION_SHAPE_DIRECTED_POINTS** = **4** + + .. _enum_CPUParticles_DrawOrder: + +enum **DrawOrder** + +- **DRAW_ORDER_INDEX** = **0** +- **DRAW_ORDER_LIFETIME** = **1** +- **DRAW_ORDER_VIEW_DEPTH** = **2** + + +Member Function Description +--------------------------- + +.. _class_CPUParticles_convert_from_particles: + +- void **convert_from_particles** **(** :ref:`Node` particles **)** + +.. _class_CPUParticles_restart: + +- void **restart** **(** **)** + + diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index cecb3702a..739c533d7 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -14,25 +14,30 @@ CSGBox Brief Description ----------------- - +A CSG Box shape. Member Variables ---------------- .. _class_CSGBox_depth: -- :ref:`float` **depth** +- :ref:`float` **depth** - Depth of the box measured from the center of the box. .. _class_CSGBox_height: -- :ref:`float` **height** +- :ref:`float` **height** - Height of the box measured from the center of the box. .. _class_CSGBox_material: -- :ref:`Material` **material** +- :ref:`Material` **material** - The material used to render the box. .. _class_CSGBox_width: -- :ref:`float` **width** +- :ref:`float` **width** - Width of the box measured from the center of the box. +Description +----------- + +This node allows you to create a box for use with the CSG system. + diff --git a/classes/class_csgcombiner.rst b/classes/class_csgcombiner.rst index e9b38d6ca..18008db3b 100644 --- a/classes/class_csgcombiner.rst +++ b/classes/class_csgcombiner.rst @@ -14,5 +14,10 @@ CSGCombiner Brief Description ----------------- +A CSG node that allows you to combine other CSG modifiers. +Description +----------- + +For complex arrangements of shapes it is sometimes needed to add structure to your CSG nodes. The CSGCombiner node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way it is possible to do operations on one set of shapes that are children of one CSGCombiner node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner node, and then do an operation that takes the two end results as their input to create the final shape. diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index a4681a775..f00c90fb8 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -14,33 +14,38 @@ CSGCylinder Brief Description ----------------- - +A CSG Cylinder shape. Member Variables ---------------- .. _class_CSGCylinder_cone: -- :ref:`bool` **cone** +- :ref:`bool` **cone** - If true a cone is created, the :ref:`radius` will only apply to one side. .. _class_CSGCylinder_height: -- :ref:`float` **height** +- :ref:`float` **height** - The height of the cylinder. .. _class_CSGCylinder_material: -- :ref:`Material` **material** +- :ref:`Material` **material** - The material used to render the cylinder. .. _class_CSGCylinder_radius: -- :ref:`float` **radius** +- :ref:`float` **radius** - The radius of the cylinder. .. _class_CSGCylinder_sides: -- :ref:`int` **sides** +- :ref:`int` **sides** - The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. .. _class_CSGCylinder_smooth_faces: -- :ref:`bool` **smooth_faces** +- :ref:`bool` **smooth_faces** - If true the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. When false the cylinder will have a flat shaded look. +Description +----------- + +This node allows you to create a cylinder (or cone) for use with the CSG system. + diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index 09b48cf6e..ea3c7c50f 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -14,13 +14,18 @@ CSGMesh Brief Description ----------------- - +A CSG Mesh shape that uses a mesh resource. Member Variables ---------------- .. _class_CSGMesh_mesh: -- :ref:`Mesh` **mesh** +- :ref:`Mesh` **mesh** - The mesh resource to use as a CSG shape. +Description +----------- + +This CSG node allows you to use any mesh resource as a CSG shape provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more then two faces. + diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index c303d87df..4d9fc17c2 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -14,50 +14,62 @@ CSGPolygon Brief Description ----------------- - +Extrudes a 2D polygon shape to create a 3D mesh. Member Variables ---------------- .. _class_CSGPolygon_depth: -- :ref:`float` **depth** +- :ref:`float` **depth** - Extrusion depth when :ref:`mode` is constant MODE_DEPTH. .. _class_CSGPolygon_material: -- :ref:`Material` **material** +- :ref:`Material` **material** - Material to use for the resulting mesh. .. _class_CSGPolygon_mode: -- :ref:`Mode` **mode** +- :ref:`Mode` **mode** - Extrusion mode. + + .. _class_CSGPolygon_path_continuous_u: + +- :ref:`bool` **path_continuous_u** - If true the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_path_interval: -- :ref:`float` **path_interval** +- :ref:`float` **path_interval** - Interval at which a new extrusion slice is added along the path when :ref:`mode` is constant MODE_PATH. + + .. _class_CSGPolygon_path_joined: + +- :ref:`bool` **path_joined** - If true the start and end of our path are joined together ensuring there is no seam when :ref:`mode` is constant MODE_PATH. + + .. _class_CSGPolygon_path_local: + +- :ref:`bool` **path_local** - If false we extrude centered on our path, if true we extrude in relation to the position of our CSGPolygon when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_path_node: -- :ref:`NodePath` **path_node** +- :ref:`NodePath` **path_node** - The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_path_rotation: -- :ref:`PathRotation` **path_rotation** +- :ref:`PathRotation` **path_rotation** - The method by which each slice is rotated along the path when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_polygon: -- :ref:`PoolVector2Array` **polygon** +- :ref:`PoolVector2Array` **polygon** - Point array that defines the shape that we'll extrude. .. _class_CSGPolygon_smooth_faces: -- :ref:`bool` **smooth_faces** +- :ref:`bool` **smooth_faces** - Generates smooth normals so smooth shading is applied to our mesh. .. _class_CSGPolygon_spin_degrees: -- :ref:`float` **spin_degrees** +- :ref:`float` **spin_degrees** - Degrees to rotate our extrusion for each slice when :ref:`mode` is constant MODE_SPIN. .. _class_CSGPolygon_spin_sides: -- :ref:`int` **spin_sides** +- :ref:`int` **spin_sides** - Number of extrusion when :ref:`mode` is constant MODE_SPIN. Enums @@ -67,16 +79,21 @@ Enums enum **Mode** -- **MODE_DEPTH** = **0** -- **MODE_SPIN** = **1** -- **MODE_PATH** = **2** +- **MODE_DEPTH** = **0** --- Shape is extruded to :ref:`depth`. +- **MODE_SPIN** = **1** --- Shape is extruded by rotating it around an axis. +- **MODE_PATH** = **2** --- Shape is extruded along a path set by a :ref:`Shape` set in :ref:`path_node`. .. _enum_CSGPolygon_PathRotation: enum **PathRotation** -- **PATH_ROTATION_POLYGON** = **0** -- **PATH_ROTATION_PATH** = **1** -- **PATH_ROTATION_PATH_FOLLOW** = **2** +- **PATH_ROTATION_POLYGON** = **0** --- Slice is not rotated. +- **PATH_ROTATION_PATH** = **1** --- Slice is rotated around the up vector of the path. +- **PATH_ROTATION_PATH_FOLLOW** = **2** --- Slice is rotate to match the path exactly. +Description +----------- + +This node takes a 2D polygon shape and extrudes it to create a 3D mesh. + diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index 19a20e8df..c187fe011 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -16,13 +16,13 @@ CSGPrimitive Brief Description ----------------- - +Base class for CSG primitives. Member Variables ---------------- .. _class_CSGPrimitive_invert_faces: -- :ref:`bool` **invert_faces** +- :ref:`bool` **invert_faces** - Invert the faces of the mesh. diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index 5f2a077d9..333c1473d 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -16,7 +16,7 @@ CSGShape Brief Description ----------------- - +The CSG base class. Member Functions ---------------- @@ -30,7 +30,7 @@ Member Variables .. _class_CSGShape_operation: -- :ref:`Operation` **operation** +- :ref:`Operation` **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. .. _class_CSGShape_snap: @@ -38,7 +38,7 @@ Member Variables .. _class_CSGShape_use_collision: -- :ref:`bool` **use_collision** +- :ref:`bool` **use_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. Enums @@ -48,11 +48,16 @@ Enums enum **Operation** -- **OPERATION_UNION** = **0** -- **OPERATION_INTERSECTION** = **1** -- **OPERATION_SUBTRACTION** = **2** +- **OPERATION_UNION** = **0** --- Geometry of both primitives is merged, intersecting geometry is removed. +- **OPERATION_INTERSECTION** = **1** --- Only intersecting geometry remains, the rest is removed. +- **OPERATION_SUBTRACTION** = **2** --- The second shape is susbtracted from the first, leaving a dent with it's shape. +Description +----------- + +This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot. + Member Function Description --------------------------- @@ -60,4 +65,6 @@ Member Function Description - :ref:`bool` **is_root_shape** **(** **)** const +Returns true if this is a root shape and is thus the object that is rendered. + diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index 513f1702f..b65d84023 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -14,29 +14,34 @@ CSGSphere Brief Description ----------------- - +A CSG Sphere shape. Member Variables ---------------- .. _class_CSGSphere_material: -- :ref:`Material` **material** +- :ref:`Material` **material** - The material used to render the sphere. .. _class_CSGSphere_radial_segments: -- :ref:`int` **radial_segments** +- :ref:`int` **radial_segments** - Number of vertical slices for the sphere. .. _class_CSGSphere_radius: -- :ref:`float` **radius** +- :ref:`float` **radius** - Radius of the sphere. .. _class_CSGSphere_rings: -- :ref:`int` **rings** +- :ref:`int` **rings** - Number of horizontal slices for the sphere. .. _class_CSGSphere_smooth_faces: -- :ref:`bool` **smooth_faces** +- :ref:`bool` **smooth_faces** - If true the normals of the sphere are set to give a smooth effect making the sphere seem rounded. When false the sphere will have a flat shaded look. +Description +----------- + +This node allows you to create a sphere for use with the CSG system. + diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index ca3278cc9..4d76537ca 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -14,33 +14,38 @@ CSGTorus Brief Description ----------------- - +A CSG Torus shape. Member Variables ---------------- .. _class_CSGTorus_inner_radius: -- :ref:`float` **inner_radius** +- :ref:`float` **inner_radius** - The inner radius of the torus. .. _class_CSGTorus_material: -- :ref:`Material` **material** +- :ref:`Material` **material** - The material used to render the torus. .. _class_CSGTorus_outer_radius: -- :ref:`float` **outer_radius** +- :ref:`float` **outer_radius** - The outer radius of the torus. .. _class_CSGTorus_ring_sides: -- :ref:`int` **ring_sides** +- :ref:`int` **ring_sides** - The number of edges each ring of the torus is constructed of. .. _class_CSGTorus_sides: -- :ref:`int` **sides** +- :ref:`int` **sides** - The number of slices the torus is constructed of. .. _class_CSGTorus_smooth_faces: -- :ref:`bool` **smooth_faces** +- :ref:`bool` **smooth_faces** - If true the normals of the torus are set to give a smooth effect making the torus seem rounded. When false the torus will have a flat shaded look. +Description +----------- + +This node allows you to create a torus for use with the CSG system. + diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst new file mode 100644 index 000000000..a12a70853 --- /dev/null +++ b/classes/class_cylindershape.rst @@ -0,0 +1,35 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the CylinderShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_CylinderShape: + +CylinderShape +============= + +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Cylinder shape for collisions. + +Member Variables +---------------- + + .. _class_CylinderShape_height: + +- :ref:`float` **height** - The cylinder's height. + + .. _class_CylinderShape_radius: + +- :ref:`float` **radius** - The cylinder's radius. + + +Description +----------- + +Cylinder shape for collisions. + diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index c0ddc794b..60e19b410 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -24,7 +24,7 @@ Member Functions +--------------------------------------+---------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`empty` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** var key **)** | +| :ref:`bool` | :ref:`erase` **(** var key **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has` **(** var key **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ @@ -67,7 +67,7 @@ Return true if the dictionary is empty. .. _class_Dictionary_erase: -- void **erase** **(** var key **)** +- :ref:`bool` **erase** **(** var key **)** Erase a dictionary key/value pair by key. diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 5be13ce44..b53907029 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -14,46 +14,46 @@ DirectionalLight Brief Description ----------------- -Directional Light, such as the Sun or the Moon. +Directional light from a distance, as from the Sun. Member Variables ---------------- .. _class_DirectionalLight_directional_shadow_bias_split_scale: -- :ref:`float` **directional_shadow_bias_split_scale** +- :ref:`float` **directional_shadow_bias_split_scale** - Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. .. _class_DirectionalLight_directional_shadow_blend_splits: -- :ref:`bool` **directional_shadow_blend_splits** +- :ref:`bool` **directional_shadow_blend_splits** - If ``true`` shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. .. _class_DirectionalLight_directional_shadow_depth_range: -- :ref:`ShadowDepthRange` **directional_shadow_depth_range** +- :ref:`ShadowDepthRange` **directional_shadow_depth_range** - Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. .. _class_DirectionalLight_directional_shadow_max_distance: -- :ref:`float` **directional_shadow_max_distance** +- :ref:`float` **directional_shadow_max_distance** - The maximum distance for shadow splits. .. _class_DirectionalLight_directional_shadow_mode: -- :ref:`ShadowMode` **directional_shadow_mode** +- :ref:`ShadowMode` **directional_shadow_mode** - The light's shadow rendering algorithm. See :ref:`ShadowMode`. .. _class_DirectionalLight_directional_shadow_normal_bias: -- :ref:`float` **directional_shadow_normal_bias** +- :ref:`float` **directional_shadow_normal_bias** - Can be used to fix special cases of self shadowing when objects are perpendicular to the light. .. _class_DirectionalLight_directional_shadow_split_1: -- :ref:`float` **directional_shadow_split_1** +- :ref:`float` **directional_shadow_split_1** - The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL\_\*_SPLITS. .. _class_DirectionalLight_directional_shadow_split_2: -- :ref:`float` **directional_shadow_split_2** +- :ref:`float` **directional_shadow_split_2** - The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL\_\*_SPLITS. .. _class_DirectionalLight_directional_shadow_split_3: -- :ref:`float` **directional_shadow_split_3** +- :ref:`float` **directional_shadow_split_3** - The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL_4_SPLITS. Enums @@ -63,20 +63,25 @@ Enums enum **ShadowDepthRange** -- **SHADOW_DEPTH_RANGE_STABLE** = **0** -- **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** +- **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_OPTIMIZED** = **1** --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. .. _enum_DirectionalLight_ShadowMode: enum **ShadowMode** -- **SHADOW_ORTHOGONAL** = **0** -- **SHADOW_PARALLEL_2_SPLITS** = **1** -- **SHADOW_PARALLEL_4_SPLITS** = **2** +- **SHADOW_ORTHOGONAL** = **0** --- Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects. +- **SHADOW_PARALLEL_2_SPLITS** = **1** --- Splits the view frustum in 2 areas, each with its own shadow map. +- **SHADOW_PARALLEL_4_SPLITS** = **2** --- Splits the view frustum in 4 areas, each with its own shadow map. Description ----------- -A DirectionalLight is a type of :ref:`Light` node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. +A directional light is a type of :ref:`Light` node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used do determine light direction. + +Tutorials +--------- + +- :doc:`../tutorials/3d/lights_and_shadows` diff --git a/classes/class_directory.rst b/classes/class_directory.rst index d6e68ea96..64af3da54 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -80,6 +80,11 @@ Here is an example on how to iterate through the files of a directory: else: print("An error occurred when trying to access the path.") +Tutorials +--------- + +- :doc:`../getting_started/step_by_step/filesystem` + Member Function Description --------------------------- diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index a31142b00..ce69ab612 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -36,6 +36,8 @@ Member Functions +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_file` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_script_classes` **(** **)** | ++--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -52,6 +54,10 @@ Emitted if the filesystem changed. Remitted if a resource is reimported. +.. _class_EditorFileSystem_script_classes_updated: + +- **script_classes_updated** **(** **)** + .. _class_EditorFileSystem_sources_changed: - **sources_changed** **(** :ref:`bool` exist **)** @@ -115,4 +121,8 @@ Check if the source of any imported resource changed. Update a file information. Call this if an external program (not Godot) modified the file. +.. _class_EditorFileSystem_update_script_classes: + +- void **update_script_classes** **(** **)** + diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 3d07e7cc4..acc133150 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -19,31 +19,35 @@ A diretory for the resource filesystem. Member Functions ---------------- -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_file_count` **(** **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdir_count` **(** **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_file_count` **(** **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_script_class_extends` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_script_class_name` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdir_count` **(** **)** const | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -89,6 +93,14 @@ Returns ``true`` if the file at index ``idx`` imported properly. Returns the path to the file at index ``idx``. +.. _class_EditorFileSystemDirectory_get_file_script_class_extends: + +- :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** const + +.. _class_EditorFileSystemDirectory_get_file_script_class_name: + +- :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** const + .. _class_EditorFileSystemDirectory_get_file_type: - :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 3790e6e6b..d6261ed28 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -50,14 +50,8 @@ Description EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your :ref:`EditorPlugin` with :ref:`EditorPlugin.add_import_plugin`. - - EditorImportPlugins work by associating with specific file extensions and a resource type. See :ref:`get_recognized_extension` and :ref:`get_resource_type`). They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the ``.import`` directory. - - - - Below is an example EditorImportPlugin that imports a :ref:`Mesh` from a file with the extension ".special" or ".spec": :: @@ -89,17 +83,22 @@ Below is an example EditorImportPlugin that imports a :ref:`Mesh` fr func get_import_options(i): return [{"name": "my_option", "default_value": false}] - func load(src, dst, opts, r_platform_variants, r_gen_files): + func import(source_file, save_path, options, r_platform_variants, r_gen_files): var file = File.new() - if file.open(src, File.READ) != OK: + if file.open(source_file, File.READ) != OK: return FAILED var mesh = Mesh.new() - var save = dst + "." + get_save_extension() - ResourceSaver.save(file, mesh) + var filename = save_path + "." + get_save_extension() + ResourceSaver.save(filename, mesh) return OK +Tutorials +--------- + +- :doc:`../tutorials/plugins/editor/import_plugins` + Member Function Description --------------------------- @@ -153,7 +152,7 @@ Get the list of file extensions to associate with this loader (case insensitive) - :ref:`String` **get_resource_type** **(** **)** virtual -Get the godot resource type associated with this loader. e.g. "Mesh" or "Animation". +Get the Godot resource type associated with this loader. e.g. "Mesh" or "Animation". .. _class_EditorImportPlugin_get_save_extension: diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 7a621ceba..9269f3588 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -16,6 +16,13 @@ Brief Description +Member Functions +---------------- + ++-------+-----------------------------------------------------------+ +| void | :ref:`refresh` **(** **)** | ++-------+-----------------------------------------------------------+ + Signals ------- @@ -23,12 +30,32 @@ Signals - **object_id_selected** **(** :ref:`int` id **)** +.. _class_EditorInspector_property_edited: + +- **property_edited** **(** :ref:`String` property **)** + .. _class_EditorInspector_property_keyed: - **property_keyed** **(** :ref:`String` property **)** +.. _class_EditorInspector_property_selected: + +- **property_selected** **(** :ref:`String` property **)** + .. _class_EditorInspector_resource_selected: - **resource_selected** **(** :ref:`Object` res, :ref:`String` prop **)** +.. _class_EditorInspector_restart_requested: + +- **restart_requested** **(** **)** + + +Member Function Description +--------------------------- + +.. _class_EditorInspector_refresh: + +- void **refresh** **(** **)** + diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 9b25127fd..abcf72f55 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -48,8 +48,6 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSpatialGizmo` | :ref:`create_spatial_gizmo` **(** :ref:`Spatial` for_spatial **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`edit` **(** :ref:`Object` object **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`InputEvent` event **)** virtual | @@ -68,6 +66,8 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ScriptCreateDialog` | :ref:`get_script_create_dialog` **(** **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | @@ -181,6 +181,11 @@ Description Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. +Tutorials +--------- + +- :doc:`../development/plugins/index` + Member Function Description --------------------------- @@ -272,12 +277,6 @@ This is used, for example, in shader editors to let the plugin know that it must Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. -.. _class_EditorPlugin_create_spatial_gizmo: - -- :ref:`EditorSpatialGizmo` **create_spatial_gizmo** **(** :ref:`Spatial` for_spatial **)** virtual - -This is used for plugins that create gizmos used by the spatial editor. Just check that the node passed in the "for_spatial" argument matches your plugin. - .. _class_EditorPlugin_edit: - void **edit** **(** :ref:`Object` object **)** virtual @@ -322,6 +321,12 @@ This is for editors that edit script based objects. You can return a list of bre - :ref:`String` **get_plugin_name** **(** **)** virtual +.. _class_EditorPlugin_get_script_create_dialog: + +- :ref:`ScriptCreateDialog` **get_script_create_dialog** **(** **)** + +Gets the Editor's dialogue used for making scripts. Note that users can configure it before use. + .. _class_EditorPlugin_get_state: - :ref:`Dictionary` **get_state** **(** **)** virtual diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index 835b1fc2e..4c76674f6 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -24,6 +24,8 @@ Member Functions +------------------------------+----------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_edited_property` **(** **)** | +------------------------------+----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------+ | void | :ref:`update_property` **(** **)** virtual | +------------------------------+----------------------------------------------------------------------------------+ @@ -102,6 +104,10 @@ Member Function Description - :ref:`String` **get_edited_property** **(** **)** +.. _class_EditorProperty_get_tooltip_text: + +- :ref:`String` **get_tooltip_text** **(** **)** const + .. _class_EditorProperty_update_property: - void **update_property** **(** **)** virtual diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index d3f520af6..cd527d187 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -14,20 +14,48 @@ EditorScenePostImport Brief Description ----------------- - +Post process scenes after import Member Functions ---------------- -+-------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`post_import` **(** :ref:`Object` scene **)** virtual | -+-------+-------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_source_file` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_source_folder` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`post_import` **(** :ref:`Object` scene **)** virtual | ++------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +The imported scene can be automatically modified right after import by specifying a 'custom script' that inherits from this class. The :ref:`post_import`-method receives the imported scene's root-node and returns the modified version of the scene + +Tutorials +--------- + +- `http://docs.godotengine.org/en/latest/learning/workflow/assets/importing_scenes.html?highlight=post%20import `_ Member Function Description --------------------------- +.. _class_EditorScenePostImport_get_source_file: + +- :ref:`String` **get_source_file** **(** **)** const + +Returns the source-file-path which got imported (e.g. ``res://scene.dae`` ) + +.. _class_EditorScenePostImport_get_source_folder: + +- :ref:`String` **get_source_folder** **(** **)** const + +Returns the resource-folder the imported scene-file is located in + .. _class_EditorScenePostImport_post_import: -- void **post_import** **(** :ref:`Object` scene **)** virtual +- :ref:`Object` **post_import** **(** :ref:`Object` scene **)** virtual + +Gets called after the scene got imported and has to return the modified version of the scene diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index ad39d65f9..fbe45a1c8 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -19,33 +19,35 @@ Custom gizmo for editing Spatial objects. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles, :ref:`AABB` bounds **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redraw` **(** **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -61,13 +63,13 @@ Member Function Description .. _class_EditorSpatialGizmo_add_collision_triangles: -- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles, :ref:`AABB` bounds **)** +- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles **)** Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this function during :ref:`redraw`. .. _class_EditorSpatialGizmo_add_handles: -- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** +- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** Add a list of handles (points) which can be used to deform the object being edited. @@ -129,6 +131,10 @@ This function is used when the user drags a gizmo handle (previously added with The :ref:`Camera` is also provided so screen coordinates can be converted to raycasts. +.. _class_EditorSpatialGizmo_set_hidden: + +- void **set_hidden** **(** :ref:`bool` hidden **)** + .. _class_EditorSpatialGizmo_set_spatial_node: - void **set_spatial_node** **(** :ref:`Node` node **)** diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 46f8cd96f..23736a214 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -83,8 +83,6 @@ Member Function Description Returns engine author information in a Dictionary. - - "lead_developers" - Array of Strings, lead developer names "founders" - Array of Strings, founder names @@ -99,8 +97,6 @@ Returns engine author information in a Dictionary. Returns an Array of copyright information Dictionaries. - - "name" - String, component name "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component @@ -153,8 +149,6 @@ Returns the main loop object (see :ref:`MainLoop` and :ref:`Scen Returns the current engine version information in a Dictionary. - - "major" - Holds the major version number as an int "minor" - Holds the minor version number as an int diff --git a/classes/class_environment.rst b/classes/class_environment.rst index f4a7c24d1..6a9fde832 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -271,6 +271,10 @@ Member Variables - :ref:`bool` **ss_reflections_roughness** + .. _class_Environment_ssao_ao_channel_affect: + +- :ref:`float` **ssao_ao_channel_affect** + .. _class_Environment_ssao_bias: - :ref:`float` **ssao_bias** @@ -404,3 +408,9 @@ Resource for environment nodes (like :ref:`WorldEnvironment/doc_classes. + +.. _class_Expression: + +Expression +========== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`execute` **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_error_text` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_execute_failed` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_Expression_execute: + +- :ref:`Variant` **execute** **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** + +.. _class_Expression_get_error_text: + +- :ref:`String` **get_error_text** **(** **)** const + +.. _class_Expression_has_execute_failed: + +- :ref:`bool` **has_execute_failed** **(** **)** const + +.. _class_Expression_parse: + +- :ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** + + diff --git a/classes/class_file.rst b/classes/class_file.rst index cbcec60e5..bc0a850b0 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -161,6 +161,11 @@ Here's a sample on how to write and read from a file: file.close() return content +Tutorials +--------- + +- :doc:`../getting_started/step_by_step/filesystem` + Member Function Description --------------------------- diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 7a8542bb0..eb9fc4a99 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -26,6 +26,8 @@ Member Functions +--------------------------------------------+-----------------------------------------------------------------------------------------------+ | void | :ref:`deselect_items` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ | void | :ref:`invalidate` **(** **)** | @@ -135,6 +137,10 @@ Clear all the added filters in the dialog. - void **deselect_items** **(** **)** +.. _class_FileDialog_get_line_edit: + +- :ref:`LineEdit` **get_line_edit** **(** **)** + .. _class_FileDialog_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 120737d39..e08278479 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -32,6 +32,11 @@ A script implemented in the GDScript programming language. The script exends the :ref:`new` creates a new instance of the script. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. +Tutorials +--------- + +- :doc:`../getting_started/scripting/gdscript/index` + Member Function Description --------------------------- diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 738da0596..43883152b 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -9,7 +9,7 @@ GeometryInstance **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`MultiMeshInstance`, :ref:`MeshInstance`, :ref:`Particles`, :ref:`SpriteBase3D`, :ref:`ImmediateGeometry` +**Inherited By:** :ref:`MultiMeshInstance`, :ref:`Particles`, :ref:`MeshInstance`, :ref:`SpriteBase3D`, :ref:`ImmediateGeometry`, :ref:`CPUParticles` **Category:** Core @@ -66,7 +66,7 @@ enum **Flags** - **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. Added documentation for GeometryInstance and VisualInstance -- **FLAG_MAX** = **1** +- **FLAG_MAX** = **2** .. _enum_GeometryInstance_ShadowCastingSetting: diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 54a5473e9..b10f6ef49 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -83,6 +83,11 @@ enum **Subdiv** - **SUBDIV_MAX** = **4** +Tutorials +--------- + +- :doc:`../tutorials/3d/gi_probes` + Member Function Description --------------------------- diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 1a7e6d9f6..c08f16afc 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -19,33 +19,37 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connectio Member Functions ---------------- -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_left_disconnect_type` **(** :ref:`int` type **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_right_disconnect_type` **(** :ref:`int` type **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_connections` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_left_disconnect_type` **(** :ref:`int` type **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`Node` node **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_left_disconnect_type` **(** :ref:`int` type **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_right_disconnect_type` **(** :ref:`int` type **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_connections` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`HBoxContainer` | :ref:`get_zoom_hbox` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_left_disconnect_type` **(** :ref:`int` type **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_connection_activity` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`Node` node **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -183,6 +187,10 @@ Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } +.. _class_GraphEdit_get_zoom_hbox: + +- :ref:`HBoxContainer` **get_zoom_hbox** **(** **)** + .. _class_GraphEdit_is_node_connected: - :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** @@ -213,6 +221,10 @@ Removes the possibility to disconnect nodes when dragging from the slot at the l Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. +.. _class_GraphEdit_set_connection_activity: + +- void **set_connection_activity** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** + .. _class_GraphEdit_set_selected: - void **set_selected** **(** :ref:`Node` node **)** diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 151ce86d3..f599dcfbd 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -113,6 +113,11 @@ A GridMap contains a collection of cells. Each grid cell refers to a :ref:`MeshL A GridMap is split into a sparse collection of octants for efficient rendering and physics processing. Every octant has the same dimensions and can contain several cells. +Tutorials +--------- + +- :doc:`../tutorials/3d/using_gridmaps` + Member Function Description --------------------------- diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 1d94c9422..e4aa5d353 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -174,6 +174,12 @@ A ``HTTPClient`` should be reused between multiple requests or to connect to dif For more information on HTTP, see https://developer.mozilla.org/en-US/docs/Web/HTTP (or read RFC 2616 to get it straight from the source: https://tools.ietf.org/html/rfc2616). +Tutorials +--------- + +- :doc:`../tutorials/networking/http_client_class` +- :doc:`../tutorials/networking/ssl_certificates` + Member Function Description --------------------------- diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 0c03d2681..c9012d44f 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -89,6 +89,11 @@ A node with the ability to send HTTP requests. Uses :ref:`HTTPClient` | :ref:`load_png_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lock` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`normalmap_to_xy` **(** **)** | @@ -104,6 +106,8 @@ Member Functions +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | @@ -145,6 +149,13 @@ enum **Interpolation** - **INTERPOLATE_NEAREST** = **0** - **INTERPOLATE_BILINEAR** = **1** - **INTERPOLATE_CUBIC** = **2** +- **INTERPOLATE_TRILINEAR** = **3** --- Performs bilinear separately on the two most suited mipmap levels, then linearly interpolates between them. + +It's slower than ``INTERPOLATE_BILINEAR``, but produces higher quality results, with much less aliasing artifacts. + +If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image. (Note that if you intend to scale multiple copies of the original image, it's better to call ``generate_mipmaps`` on it in advance, to avoid wasting processing power in generating them again and again.) + +On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. .. _enum_Image_AlphaMode: @@ -432,6 +443,12 @@ Loads an image from the binary contents of a JPEG file. Loads an image from the binary contents of a PNG file. +.. _class_Image_load_webp_from_buffer: + +- :ref:`Error` **load_webp_from_buffer** **(** :ref:`PoolByteArray` buffer **)** + +Loads an image from the binary contents of a WebP file. + .. _class_Image_lock: - void **lock** **(** **)** @@ -462,6 +479,10 @@ Resizes the image to the given ``width`` and ``height``. New pixels are calculat Resizes the image to the nearest power of 2 for the width and height. If ``square`` is ``true`` then set width and height to be the same. +.. _class_Image_rgbe_to_srgb: + +- :ref:`Image` **rgbe_to_srgb** **(** **)** + .. _class_Image_save_png: - :ref:`Error` **save_png** **(** :ref:`String` path **)** const diff --git a/classes/class_input.rst b/classes/class_input.rst index 1c54b40b1..769a04876 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -147,6 +147,11 @@ Description A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with :ref:`InputMap`. +Tutorials +--------- + +- :doc:`../tutorials/inputs/index` + Member Function Description --------------------------- diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index dc978d89b..b450f2b6b 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -56,6 +56,12 @@ Description Base class of all sort of input event. See :ref:`Node._input`. +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` +- :doc:`../tutorials/2d/2d_transforms` + Member Function Description --------------------------- diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index a76ec71fd..0f0a03aca 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -33,3 +33,8 @@ Description Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu ``Project > Project Settings > Input Map``. See :ref:`Node._input`. +Tutorials +--------- + +- `#actions <../tutorials/inputs/inputevent.html#actions>`_ in :doc:`../tutorials/inputs/inputevent` + diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index dc4b6161c..ac92b00e3 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -37,3 +37,8 @@ Description Input event type for gamepad buttons. For joysticks see :ref:`InputEventJoypadMotion`. +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 94ea1ff19..abceee2fc 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -33,3 +33,8 @@ Description Stores information about joystick motions. One ``InputEventJoypadMotion`` represents one axis at a time. +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index dac07f5cc..676715d16 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -48,6 +48,11 @@ Description Stores key presses on the keyboard. Supports key presses, key releases and :ref:`echo` events. +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + Member Function Description --------------------------- @@ -55,4 +60,6 @@ Member Function Description - :ref:`int` **get_scancode_with_modifiers** **(** **)** const +Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers`. + diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 5b3d88e55..bb384c84f 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -39,3 +39,8 @@ Description Stores general mouse events information. +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index f8e32dac7..a4baeafc4 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -29,7 +29,7 @@ Member Variables .. _class_InputEventMouseButton_factor: -- :ref:`float` **factor** - TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does +- :ref:`float` **factor** - Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported. .. _class_InputEventMouseButton_pressed: @@ -41,3 +41,8 @@ Description Contains mouse click information. See :ref:`Node._input`. +Tutorials +--------- + +- :doc:`../tutorials/inputs/mouse_and_input_coordinates` + diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index d17294db4..704275ee7 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -33,3 +33,8 @@ Description Contains mouse motion information. Supports relative, absolute positions and speed. See :ref:`Node._input`. +Tutorials +--------- + +- :doc:`../tutorials/inputs/mouse_and_input_coordinates` + diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index ed1a7d411..1cf11897f 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -43,3 +43,8 @@ Description Contains screen drag information. See :ref:`Node._input`. +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index c84e3ba31..fc177dee4 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -39,3 +39,8 @@ Description Stores multi-touch press/release information. Supports touch press, touch release and :ref:`index` for multi-touch count and order. +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index efa074590..4ad5eafd2 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -47,3 +47,8 @@ Description Contains keys events information with modifiers support like ``SHIFT`` or ``ALT``. See :ref:`Node._input`. +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 90862cfc5..1bdd4ae06 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -28,7 +28,7 @@ Member Functions +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_set_deadzone` **(** :ref:`String` deadzone, :ref:`float` arg1 **)** | +| void | :ref:`action_set_deadzone` **(** :ref:`String` action, :ref:`float` deadzone **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_action` **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -50,6 +50,11 @@ Description Manages all :ref:`InputEventAction` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action` and :ref:`action_add_event`. See :ref:`Node._input`. +Tutorials +--------- + +- `#inputmap <../tutorials/inputs/inputevent.html#inputmap>`_ in :doc:`../tutorials/inputs/inputevent` + Member Function Description --------------------------- @@ -69,21 +74,23 @@ Removes an :ref:`InputEvent` from an action. - void **action_erase_events** **(** :ref:`String` action **)** +Removes all events from an action. + .. _class_InputMap_action_has_event: - :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** -Returns true if an action has an :ref:`InputEvent` associated with it. +Returns ``true`` if the action has the given :ref:`InputEvent` associated with it. .. _class_InputMap_action_set_deadzone: -- void **action_set_deadzone** **(** :ref:`String` deadzone, :ref:`float` arg1 **)** +- void **action_set_deadzone** **(** :ref:`String` action, :ref:`float` deadzone **)** .. _class_InputMap_add_action: - void **add_action** **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** -Adds an (empty) action to the ``InputMap``, with a configurable ``deadzone``. +Adds an empty action to the ``InputMap`` with a configurable ``deadzone``. An :ref:`InputEvent` can then be added to this action with :ref:`action_add_event`. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 63d3d50aa..6fa06091a 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -34,6 +34,8 @@ Member Functions +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** const | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` idx **)** const | @@ -68,6 +70,8 @@ Member Functions +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_custom_fg_color` **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** | ++------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | @@ -202,13 +206,9 @@ enum **SelectMode** Description ----------- -This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, +This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, or both text and icon. Tooltips are supported and may be different for every item in the list. -or both text and icon. Tooltips are supported and may be different for every item in the list. Selectable items in the list - -may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled - -to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). +Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). Member Function Description --------------------------- @@ -255,6 +255,10 @@ Return count of items currently in the item list. - :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const +.. _class_ItemList_get_item_custom_fg_color: + +- :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const + .. _class_ItemList_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const @@ -351,6 +355,10 @@ Note: This method does not trigger the item selection signal. - void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** +.. _class_ItemList_set_item_custom_fg_color: + +- void **set_item_custom_fg_color** **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** + .. _class_ItemList_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index 6b166ca1c..a8e5e5297 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -28,6 +28,11 @@ Description The JavaScript singleton is implemented only in HTML5 export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. +Tutorials +--------- + +- `#calling-javascript-from-script <../getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script>`_ in :doc:`../getting_started/workflow/export/exporting_for_web` + Member Function Description --------------------------- diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index b76ae3ddf..9794a169e 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -19,57 +19,47 @@ Kinematic body 3D node. Member Functions ---------------- -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slide_count` **(** **)** const | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision` | :ref:`move_and_collide` **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true **)** | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slide_count` **(** **)** const | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision` | :ref:`move_and_collide` **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - .. _class_KinematicBody_axis_lock_angular_x: - -- :ref:`bool` **axis_lock_angular_x** - - .. _class_KinematicBody_axis_lock_angular_y: - -- :ref:`bool` **axis_lock_angular_y** - - .. _class_KinematicBody_axis_lock_angular_z: - -- :ref:`bool` **axis_lock_angular_z** - - .. _class_KinematicBody_axis_lock_linear_x: - -- :ref:`bool` **axis_lock_linear_x** - - .. _class_KinematicBody_axis_lock_linear_y: - -- :ref:`bool` **axis_lock_linear_y** - - .. _class_KinematicBody_axis_lock_linear_z: - -- :ref:`bool` **axis_lock_linear_z** - .. _class_KinematicBody_collision/safe_margin: - :ref:`float` **collision/safe_margin** - If the body is at least this close to another body, this body will consider them to be colliding. + .. _class_KinematicBody_move_lock_x: + +- :ref:`bool` **move_lock_x** + + .. _class_KinematicBody_move_lock_y: + +- :ref:`bool` **move_lock_y** + + .. _class_KinematicBody_move_lock_z: + +- :ref:`bool` **move_lock_z** + Description ----------- @@ -80,6 +70,11 @@ Simulated Motion: When these bodies are moved manually, either from code or from Kinematic Characters: KinematicBody also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. +Tutorials +--------- + +- :doc:`../tutorials/physics/kinematic_character_2d` + Member Function Description --------------------------- @@ -121,13 +116,15 @@ Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_ .. _class_KinematicBody_move_and_collide: -- :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true **)** +- :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision`, which contains information about the collision. +If ``test_only`` is ``true[/true], the body does not move but the would-be collision information is given. + .. _class_KinematicBody_move_and_slide: -- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody`` or :ref:`RigidBody`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. @@ -135,7 +132,7 @@ Moves the body along a vector. If the body collides with another, it will slide ``floor_normal`` is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of ``Vector3(0, 0, 0)``, everything is considered a wall. This is useful for topdown games. -If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. When set to lower values, the body will not be able to stand still on steep slopes. +*TODO: Update for new stop_on_slode argument.* If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. When set to lower values, the body will not be able to stand still on steep slopes. If the body collides, it will change direction a maximum of ``max_slides`` times before it stops. @@ -143,6 +140,10 @@ If the body collides, it will change direction a maximum of ``max_slides`` times Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. +.. _class_KinematicBody_move_and_slide_with_snap: + +- :ref:`Vector3` **move_and_slide_with_snap** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** + .. _class_KinematicBody_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 3ddc4e67f..8f79a9efb 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -19,25 +19,27 @@ Kinematic body 2D node. Member Functions ---------------- -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slide_count` **(** **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slide_count` **(** **)** const | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -46,6 +48,10 @@ Member Variables - :ref:`float` **collision/safe_margin** - If the body is at least this close to another body, this body will consider them to be colliding. + .. _class_KinematicBody2D_motion/sync_to_physics: + +- :ref:`bool` **motion/sync_to_physics** - 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. + Description ----------- @@ -97,13 +103,13 @@ Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_ .. _class_KinematicBody2D_move_and_collide: -- :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true **)** +- :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision2D`, which contains information about the collision. .. _class_KinematicBody2D_move_and_slide: -- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody2D`` or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. @@ -111,7 +117,7 @@ Moves the body along a vector. If the body collides with another, it will slide ``floor_normal`` is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of ``Vector2(0, 0)``, everything is considered a wall. This is useful for topdown games. -If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. When set to lower values, the body will not be able to stand still on steep slopes. +*TODO: Update for stop_on_slope argument.* If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. When set to lower values, the body will not be able to stand still on steep slopes. If the body collides, it will change direction a maximum of ``max_bounces`` times before it stops. @@ -119,6 +125,14 @@ If the body collides, it will change direction a maximum of ``max_bounces`` time Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. +.. _class_KinematicBody2D_move_and_slide_with_snap: + +- :ref:`Vector2` **move_and_slide_with_snap** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** + +Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_slide`. + +As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting``snap`` to``(0, 0)`` or by using :ref:`move_and_slide` instead. + .. _class_KinematicBody2D_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** diff --git a/classes/class_light.rst b/classes/class_light.rst index bc80024e4..8b92fa569 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -23,51 +23,51 @@ Member Variables .. _class_Light_editor_only: -- :ref:`bool` **editor_only** +- :ref:`bool` **editor_only** - If ``true`` the light only appears in the editor and will not be visible at runtime. Default value:``false``. .. _class_Light_light_bake_mode: -- :ref:`BakeMode` **light_bake_mode** +- :ref:`BakeMode` **light_bake_mode** - The light's bake mode. See :ref:`BakeMode`. .. _class_Light_light_color: -- :ref:`Color` **light_color** +- :ref:`Color` **light_color** - The light's color. .. _class_Light_light_cull_mask: -- :ref:`int` **light_cull_mask** +- :ref:`int` **light_cull_mask** - The light will affect objects in the selected layers. .. _class_Light_light_energy: -- :ref:`float` **light_energy** +- :ref:`float` **light_energy** - The light's strength multiplier. .. _class_Light_light_indirect_energy: -- :ref:`float` **light_indirect_energy** +- :ref:`float` **light_indirect_energy** - Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. .. _class_Light_light_negative: -- :ref:`bool` **light_negative** +- :ref:`bool` **light_negative** - If ``true`` the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. .. _class_Light_light_specular: -- :ref:`float` **light_specular** +- :ref:`float` **light_specular** - The intensity of the specular blob in objects affected by the light. At ``0`` the light becomes a pure diffuse light. .. _class_Light_shadow_bias: -- :ref:`float` **shadow_bias** +- :ref:`float` **shadow_bias** - 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. .. _class_Light_shadow_color: -- :ref:`Color` **shadow_color** +- :ref:`Color` **shadow_color** - The color of shadows cast by this light. .. _class_Light_shadow_contact: -- :ref:`float` **shadow_contact** +- :ref:`float` **shadow_contact** - Attempts to reduce :ref:`shadow_bias` gap. .. _class_Light_shadow_enabled: -- :ref:`bool` **shadow_enabled** +- :ref:`bool` **shadow_enabled** - If ``true`` the light will cast shadows. Default value: ``false``. .. _class_Light_shadow_reverse_cull_face: @@ -81,9 +81,9 @@ Enums enum **BakeMode** -- **BAKE_DISABLED** = **0** -- **BAKE_INDIRECT** = **1** -- **BAKE_ALL** = **2** +- **BAKE_DISABLED** = **0** --- Light is ignored when baking. Note: hiding a light does *not* affect baking. +- **BAKE_INDIRECT** = **1** --- Only indirect lighting will be baked. Default value. +- **BAKE_ALL** = **2** --- Both direct and indirect light will be baked. Note: you should hide the light if you don't want it to appear twice (dynamic and baked). .. _enum_Light_Param: @@ -112,3 +112,8 @@ Description Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. +Tutorials +--------- + +- :doc:`../tutorials/3d/lights_and_shadows` + diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 721a246d7..02e06bb13 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -96,6 +96,7 @@ enum **LineTextureMode** - **LINE_TEXTURE_NONE** = **0** --- Takes the left pixels of the texture and renders it over the whole line. - **LINE_TEXTURE_TILE** = **1** --- Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly. +- **LINE_TEXTURE_STRETCH** = **2** --- Stretches the texture across the line. Import the texture with Repeat Disabled for best results. .. _enum_Line2D_LineJointMode: diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 8635df1fb..2d9f5b438 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -70,6 +70,10 @@ Member Variables - :ref:`int` **caret_position** - The cursor's position inside the ``LineEdit``. When set, the text may scroll to accommodate it. + .. _class_LineEdit_clear_button_enabled: + +- :ref:`bool` **clear_button_enabled** + .. _class_LineEdit_context_menu_enabled: - :ref:`bool` **context_menu_enabled** - If ``true`` the context menu will appear when right clicked. diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index ca0cd5be3..277b4f63c 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -62,6 +62,7 @@ Numeric Constants - **NOTIFICATION_OS_MEMORY_WARNING** = **9** - **NOTIFICATION_TRANSLATION_CHANGED** = **90** - **NOTIFICATION_WM_ABOUT** = **91** +- **NOTIFICATION_CRASH** = **92** Description ----------- diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index b7fa446a2..db4467d74 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -91,7 +91,7 @@ enum **ArrayFormat** - **ARRAY_COMPRESS_INDEX** = **131072** - **ARRAY_FLAG_USE_2D_VERTICES** = **262144** - **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** -- **ARRAY_COMPRESS_DEFAULT** = **97792** +- **ARRAY_COMPRESS_DEFAULT** = **97280** .. _enum_Mesh_PrimitiveType: diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 42784fe87..9bf5a3b1c 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -9,6 +9,8 @@ MeshInstance **Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`SoftBody` + **Category:** Core Brief Description diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 0a8c4694e..2ff4537fe 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -19,25 +19,25 @@ High Level Multiplayer API. Member Functions ---------------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`poll` **(** **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`send_bytes` **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0 **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_root_node` **(** :ref:`Node` node **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_server` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`send_bytes` **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_root_node` **(** :ref:`Node` node **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -168,7 +168,7 @@ NOTE: This method results in RPCs and RSETs being called, so they will be execut .. _class_MultiplayerAPI_send_bytes: -- :ref:`Error` **send_bytes** **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0 **)** +- :ref:`Error` **send_bytes** **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Default ID is ``0``, i.e. broadcast to all peers. diff --git a/classes/class_multiplayerpeergdnative.rst b/classes/class_multiplayerpeergdnative.rst new file mode 100644 index 000000000..9142794fc --- /dev/null +++ b/classes/class_multiplayerpeergdnative.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the MultiplayerPeerGDNative.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_MultiplayerPeerGDNative: + +MultiplayerPeerGDNative +======================= + +**Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index cf851aa42..3095562e9 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -42,6 +42,14 @@ Member Variables - :ref:`GDNativeLibrary` **library** + .. _class_NativeScript_script_class_icon_path: + +- :ref:`String` **script_class_icon_path** + + .. _class_NativeScript_script_class_name: + +- :ref:`String` **script_class_name** + Member Function Description --------------------------- diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 20452e240..bbf4356a8 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -78,6 +78,12 @@ Description A PacketPeer implementation that should be passed to :ref:`SceneTree.set_network_peer` after being initialized as either a client or server. Events can then be handled by connecting to :ref:`SceneTree` signals. +Tutorials +--------- + +- :doc:`../tutorials/networking/high_level_multiplayer` +- `http://enet.bespin.org/usergroup0.html `_ + Member Function Description --------------------------- diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index f71dc6668..eb6728227 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -9,7 +9,7 @@ NetworkedMultiplayerPeer **Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`NetworkedMultiplayerENet`, :ref:`WebSocketMultiplayerPeer` +**Inherited By:** :ref:`MultiplayerPeerGDNative`, :ref:`NetworkedMultiplayerENet`, :ref:`WebSocketMultiplayerPeer` **Category:** Core @@ -110,6 +110,11 @@ Description Manages the connection to network peers. Assigns unique IDs to each client connected to the server. +Tutorials +--------- + +- :doc:`../tutorials/networking/high_level_multiplayer` + Member Function Description --------------------------- diff --git a/classes/class_node.rst b/classes/class_node.rst index 140cd81e8..93ef5602c 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -9,7 +9,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`Viewport`, :ref:`AudioStreamPlayer`, :ref:`EditorFileSystem`, :ref:`CanvasLayer`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`Timer`, :ref:`Tween` +**Inherited By:** :ref:`Viewport`, :ref:`AudioStreamPlayer`, :ref:`EditorFileSystem`, :ref:`SkeletonIK`, :ref:`CanvasLayer`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`AnimationTree`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`Timer`, :ref:`Tween` **Category:** Core @@ -26,6 +26,8 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_exit_tree` **(** **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | @@ -174,6 +176,8 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_priority` **(** :ref:`int` priority **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | @@ -310,6 +314,11 @@ Finally, when a node is freed with :ref:`free` or :ref:`queue_f **Networking with nodes:** After connecting to a server (or making one, see :ref:`NetworkedMultiplayerENet`) it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling :ref:`rpc` with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call Godot will use its :ref:`NodePath` (make sure node names are the same on all peers). Also take a look at the high-level networking tutorial and corresponding demos. +Tutorials +--------- + +- :doc:`../getting_started/step_by_step/scenes_and_nodes` + Member Function Description --------------------------- @@ -329,6 +338,10 @@ Called when the node is about to leave the :ref:`SceneTree` (e. Corresponds to the NOTIFICATION_EXIT_TREE notification in :ref:`Object._notification` and signal :ref:`tree_exiting`. To get notified when the node has already left the active tree, connect to the :ref:`tree_exited` +.. _class_Node__get_configuration_warning: + +- :ref:`String` **_get_configuration_warning** **(** **)** virtual + .. _class_Node__input: - void **_input** **(** :ref:`InputEvent` event **)** virtual @@ -479,9 +492,9 @@ Returns the peer ID of the network master for this node. See :ref:`set_network_m Fetches a node. The :ref:`NodePath` can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a ``null instance`` is returned and attempts to access it will result in an "Attempt to call on a null instance." error. -Note: fetching absolute paths only works when the node is inside the scene tree (see :ref:`is_inside_tree`). +**Note:** Fetching absolute paths only works when the node is inside the scene tree (see :ref:`is_inside_tree`). -*Example:* Assume your current node is Character and the following tree: +**Example:** Assume your current node is Character and the following tree: :: @@ -847,6 +860,10 @@ Enables or disables input processing. This is not required for GUI controls! Ena Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process`). Only useful for advanced uses to manipulate built-in nodes behaviour. +.. _class_Node_set_process_priority: + +- void **set_process_priority** **(** :ref:`int` priority **)** + .. _class_Node_set_process_unhandled_input: - void **set_process_unhandled_input** **(** :ref:`bool` enable **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 7db4584b0..835f8842d 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -102,6 +102,11 @@ Description A 2D game object, with a position, rotation and scale. All 2D physics nodes and sprites inherit from Node2D. Use Node2D as a parent node to move, scale and rotate children in a 2D project. Also gives control on the node's render order. +Tutorials +--------- + +- :doc:`../tutorials/2d/custom_drawing_in_2d` + Member Function Description --------------------------- diff --git a/classes/class_object.rst b/classes/class_object.rst index f16ebddaf..11179f18d 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -7,7 +7,7 @@ Object ====== -**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`PhysicsDirectBodyState`, :ref:`JavaScript`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`GodotSharp`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`VisualScriptEditor`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` +**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`PhysicsDirectBodyState`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`JavaScript`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`ProjectSettings`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`GodotSharp`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`VisualScriptEditor`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` **Category:** Core @@ -20,7 +20,7 @@ Member Functions ---------------- +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_get` **(** :ref:`String` property **)** virtual | +| :ref:`Variant` | :ref:`_get` **(** :ref:`String` property **)** virtual | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -131,6 +131,7 @@ enum **ConnectFlags** - **CONNECT_DEFERRED** = **1** --- Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time. - **CONNECT_PERSIST** = **2** --- Persisting connections are saved when the object is serialized to file. - **CONNECT_ONESHOT** = **4** --- One shot connections disconnect themselves after emission. +- **CONNECT_REFERENCE_COUNTED** = **8** Description @@ -151,7 +152,7 @@ Member Function Description .. _class_Object__get: -- void **_get** **(** :ref:`String` property **)** virtual +- :ref:`Variant` **_get** **(** :ref:`String` property **)** virtual Returns the given property. Returns ``null`` if the ``property`` does not exist. @@ -263,6 +264,10 @@ Inside each :ref:`Dictionary` there are 3 fields: - :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const +Get indexed object property by String. + +Property indices get accessed with colon seperation, for example: ``position:x`` + .. _class_Object_get_instance_id: - :ref:`int` **get_instance_id** **(** **)** const diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 5e36469cc..58a29835a 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -14,26 +14,26 @@ OmniLight Brief Description ----------------- -OmniDirectional Light, such as a light bulb or a candle. +Omnidirectional light, such as a light bulb or a candle. Member Variables ---------------- .. _class_OmniLight_omni_attenuation: -- :ref:`float` **omni_attenuation** +- :ref:`float` **omni_attenuation** - The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. .. _class_OmniLight_omni_range: -- :ref:`float` **omni_range** +- :ref:`float` **omni_range** - Maximum distance the light affects. .. _class_OmniLight_omni_shadow_detail: -- :ref:`ShadowDetail` **omni_shadow_detail** +- :ref:`ShadowDetail` **omni_shadow_detail** - See :ref:`ShadowDetail`. .. _class_OmniLight_omni_shadow_mode: -- :ref:`ShadowMode` **omni_shadow_mode** +- :ref:`ShadowMode` **omni_shadow_mode** - See :ref:`ShadowMode`. Enums @@ -57,5 +57,10 @@ enum **ShadowMode** Description ----------- -An OmniDirectional light is a type of :ref:`Light` node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light`. +An Omnidirectional light is a type of :ref:`Light` that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. + +Tutorials +--------- + +- :doc:`../tutorials/3d/lights_and_shadows` diff --git a/classes/class_os.rst b/classes/class_os.rst index 0e2fdee04..483517c08 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -46,6 +46,8 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | @@ -100,6 +102,8 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | @@ -434,6 +438,10 @@ Returns the audio driver name for the given index. Returns the command line arguments passed to the engine. +.. _class_OS_get_connected_midi_inputs: + +- :ref:`PoolStringArray` **get_connected_midi_inputs** **(** **)** + .. _class_OS_get_date: - :ref:`Dictionary` **get_date** **(** :ref:`bool` utc=false **)** const @@ -552,8 +560,6 @@ Returns the number of displays attached to the host machine. Returns the dots per inch density of the specified screen. - - On Android Devices, the actual screen densities are grouped into six generalized densities: ldpi - 120 dpi @@ -614,6 +620,12 @@ Returns the epoch time of the operating system in seconds. Returns the amount of time passed in milliseconds since the engine started. +.. _class_OS_get_ticks_usec: + +- :ref:`int` **get_ticks_usec** **(** **)** const + +Returns the amount of time passed in microseconds since the engine started. + .. _class_OS_get_time: - :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** const diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 369f7a00c..d32df0a93 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -9,7 +9,7 @@ PacketPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer`, :ref:`NetworkedMultiplayerPeer` +**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer`, :ref:`PacketPeerGDNative`, :ref:`NetworkedMultiplayerPeer` **Category:** Core diff --git a/classes/class_packetpeergdnative.rst b/classes/class_packetpeergdnative.rst new file mode 100644 index 000000000..c181f0def --- /dev/null +++ b/classes/class_packetpeergdnative.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PacketPeerGDNative.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PacketPeerGDNative: + +PacketPeerGDNative +================== + +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 4ea8c8e82..fd6d68f71 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -38,23 +38,23 @@ Member Variables .. _class_Particles_draw_pass_1: -- :ref:`Mesh` **draw_pass_1** +- :ref:`Mesh` **draw_pass_1** - :ref:`Mesh` that is drawn for the first draw pass. .. _class_Particles_draw_pass_2: -- :ref:`Mesh` **draw_pass_2** +- :ref:`Mesh` **draw_pass_2** - :ref:`Mesh` that is drawn for the second draw pass. .. _class_Particles_draw_pass_3: -- :ref:`Mesh` **draw_pass_3** +- :ref:`Mesh` **draw_pass_3** - :ref:`Mesh` that is drawn for the third draw pass. .. _class_Particles_draw_pass_4: -- :ref:`Mesh` **draw_pass_4** +- :ref:`Mesh` **draw_pass_4** - :ref:`Mesh` that is drawn for the fourth draw pass. .. _class_Particles_draw_passes: -- :ref:`int` **draw_passes** +- :ref:`int` **draw_passes** - The number of draw passes when rendering particles. .. _class_Particles_emitting: @@ -86,7 +86,7 @@ Member Variables .. _class_Particles_preprocess: -- :ref:`float` **preprocess** +- :ref:`float` **preprocess** - Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. .. _class_Particles_process_material: @@ -102,13 +102,13 @@ Member Variables .. _class_Particles_visibility_aabb: -- :ref:`AABB` **visibility_aabb** +- :ref:`AABB` **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. Numeric Constants ----------------- -- **MAX_DRAW_PASSES** = **4** +- **MAX_DRAW_PASSES** = **4** --- Maximum number of draw passes supported. Enums ----- @@ -140,4 +140,6 @@ Member Function Description - void **restart** **(** **)** +Restarts the particle emmission, clearing existing particles. + diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 1bb9dd6cd..729d1b3a1 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -57,7 +57,8 @@ enum **Monitor** - **PHYSICS_3D_ACTIVE_OBJECTS** = **24** --- Number of active :ref:`RigidBody` and :ref:`VehicleBody` nodes in the game. - **PHYSICS_3D_COLLISION_PAIRS** = **25** --- Number of collision pairs in the 3D physics engine. - **PHYSICS_3D_ISLAND_COUNT** = **26** --- Number of islands in the 3D physics engine. -- **MONITOR_MAX** = **27** +- **AUDIO_OUTPUT_LATENCY** = **27** +- **MONITOR_MAX** = **28** Description diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index c03da77da..81113d3c4 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -19,6 +19,8 @@ Brief Description Member Functions ---------------- ++--------------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_id` **(** **)** const | +--------------------------+------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_simulate_physics` **(** **)** | +--------------------------+------------------------------------------------------------------------------------+ @@ -81,6 +83,10 @@ enum **JointType** Member Function Description --------------------------- +.. _class_PhysicalBone_get_bone_id: + +- :ref:`int` **get_bone_id** **(** **)** const + .. _class_PhysicalBone_get_simulate_physics: - :ref:`bool` **get_simulate_physics** **(** **)** diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 8875c045d..a69431527 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -21,6 +21,18 @@ Direct access object to a physics body in the :ref:`Physics2DServer` **(** :ref:`Vector2` force **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_torque` **(** :ref:`float` torque **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_torque_impulse` **(** :ref:`float` impulse **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -101,6 +113,30 @@ Direct access object to a physics body in the :ref:`Physics2DServer` force **)** + +.. _class_Physics2DDirectBodyState_add_force: + +- void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** + +.. _class_Physics2DDirectBodyState_add_torque: + +- void **add_torque** **(** :ref:`float` torque **)** + +.. _class_Physics2DDirectBodyState_apply_central_impulse: + +- void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** + +.. _class_Physics2DDirectBodyState_apply_impulse: + +- void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** + +.. _class_Physics2DDirectBodyState_apply_torque_impulse: + +- void **apply_torque_impulse** **(** :ref:`float` impulse **)** + .. _class_Physics2DDirectBodyState_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index cf5ba197a..a9e05b5e4 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -38,6 +38,11 @@ Description Direct access object to a space in the :ref:`Physics2DServer`. It's used mainly to do queries against objects and areas residing in a given space. +Tutorials +--------- + +- :doc:`../tutorials/physics/ray-casting` + Member Function Description --------------------------- diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index c06ef7dcd..0f89a9543 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -72,14 +72,22 @@ Member Functions +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | ++---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | ++---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** | ++---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`float` impulse **)** | ++---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | @@ -507,6 +515,10 @@ Sets the space override mode for the area. The modes are described in the consta Sets the transform matrix for an area. +.. _class_Physics2DServer_body_add_central_force: + +- void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** + .. _class_Physics2DServer_body_add_collision_exception: - void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** @@ -525,12 +537,24 @@ Adds a positioned force to the applied force and torque. As with :ref:`body_appl Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. +.. _class_Physics2DServer_body_add_torque: + +- void **body_add_torque** **(** :ref:`RID` body, :ref:`float` torque **)** + +.. _class_Physics2DServer_body_apply_central_impulse: + +- void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** + .. _class_Physics2DServer_body_apply_impulse: - void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. +.. _class_Physics2DServer_body_apply_torque_impulse: + +- void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** + .. _class_Physics2DServer_body_attach_object_instance_id: - void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index e336e35c8..ed8c9c630 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -56,6 +56,11 @@ Description PhysicsBody is an abstract base class for implementing a physics body. All \*Body types inherit from it. +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + Member Function Description --------------------------- diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index ded5685fe..4c86fb4fd 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -60,6 +60,11 @@ Description PhysicsBody2D is an abstract base class for implementing a physics body. All \*Body2D types inherit from it. +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + Member Function Description --------------------------- diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index 6a345dbe9..4e71dab1d 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -28,6 +28,8 @@ Member Functions +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` j **)** | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` j **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` j **)** | @@ -46,6 +48,8 @@ Member Functions +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_count` **(** **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_contact_impulse` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | @@ -124,6 +128,10 @@ Member Function Description - void **add_torque** **(** :ref:`Vector3` torque **)** +.. _class_PhysicsDirectBodyState_apply_central_impulse: + +- void **apply_central_impulse** **(** :ref:`Vector3` j **)** + .. _class_PhysicsDirectBodyState_apply_impulse: - void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` j **)** @@ -160,6 +168,12 @@ Member Function Description - :ref:`int` **get_contact_count** **(** **)** const +.. _class_PhysicsDirectBodyState_get_contact_impulse: + +- :ref:`float` **get_contact_impulse** **(** :ref:`int` contact_idx **)** const + +Impulse created by the contact. Only implemented for Bullet physics. + .. _class_PhysicsDirectBodyState_get_contact_local_normal: - :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 8142367db..323a85c1a 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -36,6 +36,11 @@ Description Direct access object to a space in the :ref:`PhysicsServer`. It's used mainly to do queries against objects and areas residing in a given space. +Tutorials +--------- + +- :doc:`../tutorials/physics/ray-casting` + Member Function Description --------------------------- diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst new file mode 100644 index 000000000..082c434d4 --- /dev/null +++ b/classes/class_physicsmaterial.rst @@ -0,0 +1,38 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PhysicsMaterial.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PhysicsMaterial: + +PhysicsMaterial +=============== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_PhysicsMaterial_absorbent: + +- :ref:`bool` **absorbent** + + .. _class_PhysicsMaterial_bounce: + +- :ref:`float` **bounce** + + .. _class_PhysicsMaterial_friction: + +- :ref:`float` **friction** + + .. _class_PhysicsMaterial_rough: + +- :ref:`bool` **rough** + + diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index d8553fced..70c1aa1ce 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -74,10 +74,18 @@ Member Functions +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | @@ -288,10 +296,11 @@ enum **ShapeType** - **SHAPE_SPHERE** = **2** --- The :ref:`Shape` is a :ref:`SphereShape`. - **SHAPE_BOX** = **3** --- The :ref:`Shape` is a :ref:`BoxShape`. - **SHAPE_CAPSULE** = **4** --- The :ref:`Shape` is a :ref:`CapsuleShape`. -- **SHAPE_CONVEX_POLYGON** = **5** --- The :ref:`Shape` is a :ref:`ConvexPolygonShape`. -- **SHAPE_CONCAVE_POLYGON** = **6** --- The :ref:`Shape` is a :ref:`ConcavePolygonShape`. -- **SHAPE_HEIGHTMAP** = **7** --- The :ref:`Shape` is a HeightMapShape. -- **SHAPE_CUSTOM** = **8** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. +- **SHAPE_CYLINDER** = **5** --- The :ref:`Shape` is a :ref:`CylinderShape`. +- **SHAPE_CONVEX_POLYGON** = **6** --- The :ref:`Shape` is a :ref:`ConvexPolygonShape`. +- **SHAPE_CONCAVE_POLYGON** = **7** --- The :ref:`Shape` is a :ref:`ConcavePolygonShape`. +- **SHAPE_HEIGHTMAP** = **8** --- The :ref:`Shape` is a HeightMapShape. +- **SHAPE_CUSTOM** = **9** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. .. _enum_PhysicsServer_HingeJointFlag: @@ -639,18 +648,34 @@ Sets the space override mode for the area. The modes are described in the consta Sets the transform matrix for an area. +.. _class_PhysicsServer_body_add_central_force: + +- void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** + .. _class_PhysicsServer_body_add_collision_exception: - void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Adds a body to the list of bodies exempt from collisions. +.. _class_PhysicsServer_body_add_force: + +- void **body_add_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** + .. _class_PhysicsServer_body_add_shape: - void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. +.. _class_PhysicsServer_body_add_torque: + +- void **body_add_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** + +.. _class_PhysicsServer_body_apply_central_impulse: + +- void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** + .. _class_PhysicsServer_body_apply_impulse: - void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 8f57ee039..d88ab2ae5 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -69,11 +69,23 @@ Member Variables - :ref:`float` **z** +Numeric Constants +----------------- + +- **X** = **Plane( 1, 0, 0, 0 )** +- **Y** = **Plane( 0, 1, 0, 0 )** +- **Z** = **Plane( 0, 0, 1, 0 )** + Description ----------- Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. +Tutorials +--------- + +- :doc:`../tutorials/math/index` + Member Function Description --------------------------- diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index cb36d372e..7442371af 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -38,7 +38,7 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_radio_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** **)** | +| void | :ref:`add_separator` **(** :ref:`String` label="" **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -66,6 +66,8 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_window_lose_focus` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | @@ -76,8 +78,12 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` idx **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_window_lose_focus` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | @@ -100,6 +106,8 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | @@ -148,6 +156,10 @@ Member Variables - :ref:`bool` **hide_on_state_item_selection** + .. _class_PopupMenu_submenu_popup_delay: + +- :ref:`float` **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. + Description ----------- @@ -207,7 +219,7 @@ The same as :ref:`add_check_item` but the insert .. _class_PopupMenu_add_separator: -- void **add_separator** **(** **)** +- void **add_separator** **(** :ref:`String` label="" **)** Add a separator between items. Separators also occupy an index. @@ -283,6 +295,10 @@ Return the text of the item at index "idx". - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +.. _class_PopupMenu_is_hide_on_window_lose_focus: + +- :ref:`bool` **is_hide_on_window_lose_focus** **(** **)** const + .. _class_PopupMenu_is_item_checkable: - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const @@ -313,12 +329,20 @@ Return whether the item at index "idx" has radio-button-style checkability. Reme Return whether the item is a separator. If it is, it would be displayed as a line. +.. _class_PopupMenu_is_item_shortcut_disabled: + +- :ref:`bool` **is_item_shortcut_disabled** **(** :ref:`int` idx **)** const + .. _class_PopupMenu_remove_item: - void **remove_item** **(** :ref:`int` idx **)** Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. +.. _class_PopupMenu_set_hide_on_window_lose_focus: + +- void **set_hide_on_window_lose_focus** **(** :ref:`bool` enable **)** + .. _class_PopupMenu_set_item_accelerator: - void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** @@ -381,6 +405,10 @@ Sets the metadata of an item, which might be of any type. You can later get it w - void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** +.. _class_PopupMenu_set_item_shortcut_disabled: + +- void **set_item_shortcut_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** + .. _class_PopupMenu_set_item_submenu: - void **set_item_submenu** **(** :ref:`int` idx, :ref:`String` submenu **)** diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 542451d1c..196ab596f 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -21,7 +21,7 @@ Member Variables .. _class_PrismMesh_left_to_right: -- :ref:`float` **left_to_right** - Displacement of of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). +- :ref:`float` **left_to_right** - Displacement of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). .. _class_PrismMesh_size: diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 787a6ad65..595144fe3 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -21,7 +21,7 @@ Member Variables .. _class_ProgressBar_percent_visible: -- :ref:`bool` **percent_visible** +- :ref:`bool` **percent_visible** - If ``true`` the fill percentage is displayed on the bar. Default value: ``true``. Description diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 64945132c..0b030eeb8 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -51,6 +51,976 @@ Member Functions | void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + + .. _class_ProjectSettings_application/boot_splash/fullsize: + +- :ref:`bool` **application/boot_splash/fullsize** - Scale the boot splash image to the full window length when engine starts (will leave it as default pixel size otherwise). + + .. _class_ProjectSettings_application/boot_splash/image: + +- :ref:`String` **application/boot_splash/image** - Path to an image used for boot splash. + + .. _class_ProjectSettings_application/config/custom_user_dir_name: + +- :ref:`String` **application/config/custom_user_dir_name** - This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing. + +the "use_custom_user_dir" setting must be enabled for this to take effect. + + .. _class_ProjectSettings_application/config/icon: + +- :ref:`String` **application/config/icon** - Icon used for the project, set when project loads. Exporters will use this icon when possible to. + + .. _class_ProjectSettings_application/config/name: + +- :ref:`String` **application/config/name** - Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages. + + .. _class_ProjectSettings_application/config/use_custom_user_dir: + +- :ref:`bool` **application/config/use_custom_user_dir** - Allow the project to save to it's own custom user dir (in AppData on windows or ~/.config on unixes). This setting only works for desktop exporters. A name must be set in the "custom_user_dir_name" setting for this to take effect. + + .. _class_ProjectSettings_application/run/disable_stderr: + +- :ref:`bool` **application/run/disable_stderr** - Disable printing to stderr on exported build. + + .. _class_ProjectSettings_application/run/disable_stdout: + +- :ref:`bool` **application/run/disable_stdout** - Disable printing to stdout on exported build. + + .. _class_ProjectSettings_application/run/frame_delay_msec: + +- :ref:`int` **application/run/frame_delay_msec** - Force a delay between frames in the main loop. This may be useful if you plan to disable vsync. + + .. _class_ProjectSettings_application/run/low_processor_mode: + +- :ref:`bool` **application/run/low_processor_mode** - Turn on low processor mode. This setting only works on desktops. 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) on games. + + .. _class_ProjectSettings_application/run/low_processor_mode_sleep_usec: + +- :ref:`int` **application/run/low_processor_mode_sleep_usec** - Amount of sleeping between frames when the low_processor_mode is enabled. This effectively reduces CPU usage when this mode is enabled. + + .. _class_ProjectSettings_application/run/main_scene: + +- :ref:`String` **application/run/main_scene** - Path to the main scene file that will be loaded when the project runs. + + .. _class_ProjectSettings_audio/channel_disable_threshold_db: + +- :ref:`float` **audio/channel_disable_threshold_db** - 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_audio/channel_disable_time: + +- :ref:`float` **audio/channel_disable_time** - 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_audio/driver: + +- :ref:`String` **audio/driver** + + .. _class_ProjectSettings_audio/mix_rate: + +- :ref:`int` **audio/mix_rate** - Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system. + + .. _class_ProjectSettings_audio/output_latency: + +- :ref:`int` **audio/output_latency** + + .. _class_ProjectSettings_audio/video_delay_compensation_ms: + +- :ref:`int` **audio/video_delay_compensation_ms** - Setting to harcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. + + .. _class_ProjectSettings_compression/formats/gzip/compression_level: + +- :ref:`int` **compression/formats/gzip/compression_level** - Default compression level for gzip. Affects compressed scenes and resources. + + .. _class_ProjectSettings_compression/formats/zlib/compression_level: + +- :ref:`int` **compression/formats/zlib/compression_level** - Default compression level for zlib. Affects compressed scenes and resources. + + .. _class_ProjectSettings_compression/formats/zstd/compression_level: + +- :ref:`int` **compression/formats/zstd/compression_level** - Default compression level for zstd. Affects compressed scenes and resources. + + .. _class_ProjectSettings_compression/formats/zstd/long_distance_matching: + +- :ref:`bool` **compression/formats/zstd/long_distance_matching** - Enable long distance matching in zstd. + + .. _class_ProjectSettings_compression/formats/zstd/window_log_size: + +- :ref:`int` **compression/formats/zstd/window_log_size** + + .. _class_ProjectSettings_debug/gdscript/warnings/constant_used_as_function: + +- :ref:`bool` **debug/gdscript/warnings/constant_used_as_function** + + .. _class_ProjectSettings_debug/gdscript/warnings/enable: + +- :ref:`bool` **debug/gdscript/warnings/enable** + + .. _class_ProjectSettings_debug/gdscript/warnings/function_conflicts_constant: + +- :ref:`bool` **debug/gdscript/warnings/function_conflicts_constant** + + .. _class_ProjectSettings_debug/gdscript/warnings/function_conflicts_variable: + +- :ref:`bool` **debug/gdscript/warnings/function_conflicts_variable** + + .. _class_ProjectSettings_debug/gdscript/warnings/function_may_yield: + +- :ref:`bool` **debug/gdscript/warnings/function_may_yield** + + .. _class_ProjectSettings_debug/gdscript/warnings/function_used_as_property: + +- :ref:`bool` **debug/gdscript/warnings/function_used_as_property** + + .. _class_ProjectSettings_debug/gdscript/warnings/incompatible_ternary: + +- :ref:`bool` **debug/gdscript/warnings/incompatible_ternary** + + .. _class_ProjectSettings_debug/gdscript/warnings/integer_division: + +- :ref:`bool` **debug/gdscript/warnings/integer_division** + + .. _class_ProjectSettings_debug/gdscript/warnings/narrowing_conversion: + +- :ref:`bool` **debug/gdscript/warnings/narrowing_conversion** + + .. _class_ProjectSettings_debug/gdscript/warnings/property_used_as_function: + +- :ref:`bool` **debug/gdscript/warnings/property_used_as_function** + + .. _class_ProjectSettings_debug/gdscript/warnings/return_value_discarded: + +- :ref:`bool` **debug/gdscript/warnings/return_value_discarded** + + .. _class_ProjectSettings_debug/gdscript/warnings/standalone_expression: + +- :ref:`bool` **debug/gdscript/warnings/standalone_expression** + + .. _class_ProjectSettings_debug/gdscript/warnings/treat_warnings_as_errors: + +- :ref:`bool` **debug/gdscript/warnings/treat_warnings_as_errors** + + .. _class_ProjectSettings_debug/gdscript/warnings/unassigned_variable: + +- :ref:`bool` **debug/gdscript/warnings/unassigned_variable** + + .. _class_ProjectSettings_debug/gdscript/warnings/unassigned_variable_op_assign: + +- :ref:`bool` **debug/gdscript/warnings/unassigned_variable_op_assign** + + .. _class_ProjectSettings_debug/gdscript/warnings/unreachable_code: + +- :ref:`bool` **debug/gdscript/warnings/unreachable_code** + + .. _class_ProjectSettings_debug/gdscript/warnings/unsafe_call_argument: + +- :ref:`bool` **debug/gdscript/warnings/unsafe_call_argument** + + .. _class_ProjectSettings_debug/gdscript/warnings/unsafe_cast: + +- :ref:`bool` **debug/gdscript/warnings/unsafe_cast** + + .. _class_ProjectSettings_debug/gdscript/warnings/unsafe_method_access: + +- :ref:`bool` **debug/gdscript/warnings/unsafe_method_access** + + .. _class_ProjectSettings_debug/gdscript/warnings/unsafe_property_access: + +- :ref:`bool` **debug/gdscript/warnings/unsafe_property_access** + + .. _class_ProjectSettings_debug/gdscript/warnings/unused_argument: + +- :ref:`bool` **debug/gdscript/warnings/unused_argument** + + .. _class_ProjectSettings_debug/gdscript/warnings/unused_class_variable: + +- :ref:`bool` **debug/gdscript/warnings/unused_class_variable** + + .. _class_ProjectSettings_debug/gdscript/warnings/unused_signal: + +- :ref:`bool` **debug/gdscript/warnings/unused_signal** + + .. _class_ProjectSettings_debug/gdscript/warnings/unused_variable: + +- :ref:`bool` **debug/gdscript/warnings/unused_variable** + + .. _class_ProjectSettings_debug/gdscript/warnings/variable_conflicts_function: + +- :ref:`bool` **debug/gdscript/warnings/variable_conflicts_function** + + .. _class_ProjectSettings_debug/gdscript/warnings/void_assignment: + +- :ref:`bool` **debug/gdscript/warnings/void_assignment** + + .. _class_ProjectSettings_debug/settings/crash_handler/message: + +- :ref:`String` **debug/settings/crash_handler/message** + + .. _class_ProjectSettings_debug/settings/fps/force_fps: + +- :ref:`int` **debug/settings/fps/force_fps** + + .. _class_ProjectSettings_debug/settings/gdscript/max_call_stack: + +- :ref:`int` **debug/settings/gdscript/max_call_stack** - Maximum call stack allowed for debugging GDScript. + + .. _class_ProjectSettings_debug/settings/profiler/max_functions: + +- :ref:`int` **debug/settings/profiler/max_functions** - Maximum amount of functions per frame allowed when profiling. + + .. _class_ProjectSettings_debug/settings/stdout/print_fps: + +- :ref:`bool` **debug/settings/stdout/print_fps** - Print frames per second to stdout. Not very useful in general. + + .. _class_ProjectSettings_debug/settings/stdout/verbose_stdout: + +- :ref:`bool` **debug/settings/stdout/verbose_stdout** - Print more information to stdout when running. It shows info such as memory leaks, which scenes and resources are being loaded, etc. + + .. _class_ProjectSettings_debug/settings/visual_script/max_call_stack: + +- :ref:`int` **debug/settings/visual_script/max_call_stack** - Maximum call stack in visual scripting, to avoid infinite recursion. + + .. _class_ProjectSettings_display/mouse_cursor/custom_image: + +- :ref:`String` **display/mouse_cursor/custom_image** - Custom image for the mouse cursor. + + .. _class_ProjectSettings_display/mouse_cursor/custom_image_hotspot: + +- :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** - Hotspot for the custom mouse cursor image. + + .. _class_ProjectSettings_display/window/allow_per_pixel_transparency: + +- :ref:`bool` **display/window/allow_per_pixel_transparency** - Allow per pixel transparency in a Desktop window. This affects performance if not needed, so leave it off. + + .. _class_ProjectSettings_display/window/dpi/allow_hidpi: + +- :ref:`bool` **display/window/dpi/allow_hidpi** - Allow HiDPI display on Windows and OSX. On Desktop Linux, this can't be enabled or disabled. + + .. _class_ProjectSettings_display/window/energy_saving/keep_screen_on: + +- :ref:`bool` **display/window/energy_saving/keep_screen_on** - Force keep the screen on, so the screensaver does not take over. Works on Desktop and Mobile. + + .. _class_ProjectSettings_display/window/handheld/orientation: + +- :ref:`String` **display/window/handheld/orientation** - Default orientation for cell phone or tablet. + + .. _class_ProjectSettings_display/window/per_pixel_transparency: + +- :ref:`bool` **display/window/per_pixel_transparency** + + .. _class_ProjectSettings_display/window/per_pixel_transparency_splash: + +- :ref:`bool` **display/window/per_pixel_transparency_splash** + + .. _class_ProjectSettings_display/window/size/always_on_top: + +- :ref:`bool` **display/window/size/always_on_top** - Force the window to be always on top. + + .. _class_ProjectSettings_display/window/size/borderless: + +- :ref:`bool` **display/window/size/borderless** - Force the window to be borderless. + + .. _class_ProjectSettings_display/window/size/fullscreen: + +- :ref:`bool` **display/window/size/fullscreen** - Set the window to full screen when it starts. + + .. _class_ProjectSettings_display/window/size/height: + +- :ref:`int` **display/window/size/height** - Set 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_display/window/size/resizable: + +- :ref:`bool` **display/window/size/resizable** - Allow the window to be resizable by default. + + .. _class_ProjectSettings_display/window/size/test_height: + +- :ref:`int` **display/window/size/test_height** - Test a different height for the window. The main use for this is to test with stretch modes. + + .. _class_ProjectSettings_display/window/size/test_width: + +- :ref:`int` **display/window/size/test_width** - Test a different width for the window. The main use for this is to test with stretch modes. + + .. _class_ProjectSettings_display/window/size/width: + +- :ref:`int` **display/window/size/width** - Set the main window width. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. + + .. _class_ProjectSettings_display/window/vsync/use_vsync: + +- :ref:`bool` **display/window/vsync/use_vsync** - Use VSync. Don't be stupid, don't turn this off. + + .. _class_ProjectSettings_editor/active: + +- :ref:`bool` **editor/active** - Internal editor setting, don't touch. + + .. _class_ProjectSettings_gui/common/default_scroll_deadzone: + +- :ref:`int` **gui/common/default_scroll_deadzone** + + .. _class_ProjectSettings_gui/common/swap_ok_cancel: + +- :ref:`bool` **gui/common/swap_ok_cancel** - Enable swap OK and Cancel buttons on dialogs. This is because Windows/MacOS/Desktop Linux may use them in different order, so the GUI swaps them depending on the host OS. Disable this behavior by turning this setting off. + + .. _class_ProjectSettings_gui/theme/custom: + +- :ref:`String` **gui/theme/custom** - Use a custom theme resource, set a path to it here. + + .. _class_ProjectSettings_gui/theme/custom_font: + +- :ref:`String` **gui/theme/custom_font** - USe a custom default font resource, set a path to it here. + + .. _class_ProjectSettings_gui/theme/use_hidpi: + +- :ref:`bool` **gui/theme/use_hidpi** - Make sure the theme used works with hidpi. + + .. _class_ProjectSettings_gui/timers/incremental_search_max_interval_msec: + +- :ref:`int` **gui/timers/incremental_search_max_interval_msec** - Timer setting for incremental search in Tree, IntemList, etc. controls. + + .. _class_ProjectSettings_gui/timers/text_edit_idle_detect_sec: + +- :ref:`int` **gui/timers/text_edit_idle_detect_sec** - Timer for detecting idle in the editor. + + .. _class_ProjectSettings_input/ui_accept: + +- :ref:`Dictionary` **input/ui_accept** + + .. _class_ProjectSettings_input/ui_cancel: + +- :ref:`Dictionary` **input/ui_cancel** + + .. _class_ProjectSettings_input/ui_down: + +- :ref:`Dictionary` **input/ui_down** + + .. _class_ProjectSettings_input/ui_end: + +- :ref:`Dictionary` **input/ui_end** + + .. _class_ProjectSettings_input/ui_focus_next: + +- :ref:`Dictionary` **input/ui_focus_next** + + .. _class_ProjectSettings_input/ui_focus_prev: + +- :ref:`Dictionary` **input/ui_focus_prev** + + .. _class_ProjectSettings_input/ui_home: + +- :ref:`Dictionary` **input/ui_home** + + .. _class_ProjectSettings_input/ui_left: + +- :ref:`Dictionary` **input/ui_left** + + .. _class_ProjectSettings_input/ui_page_down: + +- :ref:`Dictionary` **input/ui_page_down** + + .. _class_ProjectSettings_input/ui_page_up: + +- :ref:`Dictionary` **input/ui_page_up** + + .. _class_ProjectSettings_input/ui_right: + +- :ref:`Dictionary` **input/ui_right** + + .. _class_ProjectSettings_input/ui_select: + +- :ref:`Dictionary` **input/ui_select** + + .. _class_ProjectSettings_input/ui_up: + +- :ref:`Dictionary` **input/ui_up** + + .. _class_ProjectSettings_input_devices/pointing/emulate_mouse_from_touch: + +- :ref:`bool` **input_devices/pointing/emulate_mouse_from_touch** + + .. _class_ProjectSettings_input_devices/pointing/emulate_touch_from_mouse: + +- :ref:`bool` **input_devices/pointing/emulate_touch_from_mouse** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_1: + +- :ref:`String` **layer_names/2d_physics/layer_1** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_10: + +- :ref:`String` **layer_names/2d_physics/layer_10** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_11: + +- :ref:`String` **layer_names/2d_physics/layer_11** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_12: + +- :ref:`String` **layer_names/2d_physics/layer_12** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_13: + +- :ref:`String` **layer_names/2d_physics/layer_13** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_14: + +- :ref:`String` **layer_names/2d_physics/layer_14** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_15: + +- :ref:`String` **layer_names/2d_physics/layer_15** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_16: + +- :ref:`String` **layer_names/2d_physics/layer_16** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_17: + +- :ref:`String` **layer_names/2d_physics/layer_17** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_18: + +- :ref:`String` **layer_names/2d_physics/layer_18** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_19: + +- :ref:`String` **layer_names/2d_physics/layer_19** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_2: + +- :ref:`String` **layer_names/2d_physics/layer_2** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_20: + +- :ref:`String` **layer_names/2d_physics/layer_20** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_3: + +- :ref:`String` **layer_names/2d_physics/layer_3** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_4: + +- :ref:`String` **layer_names/2d_physics/layer_4** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_5: + +- :ref:`String` **layer_names/2d_physics/layer_5** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_6: + +- :ref:`String` **layer_names/2d_physics/layer_6** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_7: + +- :ref:`String` **layer_names/2d_physics/layer_7** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_8: + +- :ref:`String` **layer_names/2d_physics/layer_8** + + .. _class_ProjectSettings_layer_names/2d_physics/layer_9: + +- :ref:`String` **layer_names/2d_physics/layer_9** + + .. _class_ProjectSettings_layer_names/2d_render/layer_1: + +- :ref:`String` **layer_names/2d_render/layer_1** + + .. _class_ProjectSettings_layer_names/2d_render/layer_10: + +- :ref:`String` **layer_names/2d_render/layer_10** + + .. _class_ProjectSettings_layer_names/2d_render/layer_11: + +- :ref:`String` **layer_names/2d_render/layer_11** + + .. _class_ProjectSettings_layer_names/2d_render/layer_12: + +- :ref:`String` **layer_names/2d_render/layer_12** + + .. _class_ProjectSettings_layer_names/2d_render/layer_13: + +- :ref:`String` **layer_names/2d_render/layer_13** + + .. _class_ProjectSettings_layer_names/2d_render/layer_14: + +- :ref:`String` **layer_names/2d_render/layer_14** + + .. _class_ProjectSettings_layer_names/2d_render/layer_15: + +- :ref:`String` **layer_names/2d_render/layer_15** + + .. _class_ProjectSettings_layer_names/2d_render/layer_16: + +- :ref:`String` **layer_names/2d_render/layer_16** + + .. _class_ProjectSettings_layer_names/2d_render/layer_17: + +- :ref:`String` **layer_names/2d_render/layer_17** + + .. _class_ProjectSettings_layer_names/2d_render/layer_18: + +- :ref:`String` **layer_names/2d_render/layer_18** + + .. _class_ProjectSettings_layer_names/2d_render/layer_19: + +- :ref:`String` **layer_names/2d_render/layer_19** + + .. _class_ProjectSettings_layer_names/2d_render/layer_2: + +- :ref:`String` **layer_names/2d_render/layer_2** + + .. _class_ProjectSettings_layer_names/2d_render/layer_20: + +- :ref:`String` **layer_names/2d_render/layer_20** + + .. _class_ProjectSettings_layer_names/2d_render/layer_3: + +- :ref:`String` **layer_names/2d_render/layer_3** + + .. _class_ProjectSettings_layer_names/2d_render/layer_4: + +- :ref:`String` **layer_names/2d_render/layer_4** + + .. _class_ProjectSettings_layer_names/2d_render/layer_5: + +- :ref:`String` **layer_names/2d_render/layer_5** + + .. _class_ProjectSettings_layer_names/2d_render/layer_6: + +- :ref:`String` **layer_names/2d_render/layer_6** + + .. _class_ProjectSettings_layer_names/2d_render/layer_7: + +- :ref:`String` **layer_names/2d_render/layer_7** + + .. _class_ProjectSettings_layer_names/2d_render/layer_8: + +- :ref:`String` **layer_names/2d_render/layer_8** + + .. _class_ProjectSettings_layer_names/2d_render/layer_9: + +- :ref:`String` **layer_names/2d_render/layer_9** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_1: + +- :ref:`String` **layer_names/3d_physics/layer_1** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_10: + +- :ref:`String` **layer_names/3d_physics/layer_10** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_11: + +- :ref:`String` **layer_names/3d_physics/layer_11** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_12: + +- :ref:`String` **layer_names/3d_physics/layer_12** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_13: + +- :ref:`String` **layer_names/3d_physics/layer_13** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_14: + +- :ref:`String` **layer_names/3d_physics/layer_14** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_15: + +- :ref:`String` **layer_names/3d_physics/layer_15** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_16: + +- :ref:`String` **layer_names/3d_physics/layer_16** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_17: + +- :ref:`String` **layer_names/3d_physics/layer_17** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_18: + +- :ref:`String` **layer_names/3d_physics/layer_18** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_19: + +- :ref:`String` **layer_names/3d_physics/layer_19** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_2: + +- :ref:`String` **layer_names/3d_physics/layer_2** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_20: + +- :ref:`String` **layer_names/3d_physics/layer_20** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_3: + +- :ref:`String` **layer_names/3d_physics/layer_3** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_4: + +- :ref:`String` **layer_names/3d_physics/layer_4** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_5: + +- :ref:`String` **layer_names/3d_physics/layer_5** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_6: + +- :ref:`String` **layer_names/3d_physics/layer_6** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_7: + +- :ref:`String` **layer_names/3d_physics/layer_7** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_8: + +- :ref:`String` **layer_names/3d_physics/layer_8** + + .. _class_ProjectSettings_layer_names/3d_physics/layer_9: + +- :ref:`String` **layer_names/3d_physics/layer_9** + + .. _class_ProjectSettings_layer_names/3d_render/layer_1: + +- :ref:`String` **layer_names/3d_render/layer_1** + + .. _class_ProjectSettings_layer_names/3d_render/layer_10: + +- :ref:`String` **layer_names/3d_render/layer_10** + + .. _class_ProjectSettings_layer_names/3d_render/layer_11: + +- :ref:`String` **layer_names/3d_render/layer_11** + + .. _class_ProjectSettings_layer_names/3d_render/layer_12: + +- :ref:`String` **layer_names/3d_render/layer_12** + + .. _class_ProjectSettings_layer_names/3d_render/layer_13: + +- :ref:`String` **layer_names/3d_render/layer_13** + + .. _class_ProjectSettings_layer_names/3d_render/layer_14: + +- :ref:`String` **layer_names/3d_render/layer_14** + + .. _class_ProjectSettings_layer_names/3d_render/layer_15: + +- :ref:`String` **layer_names/3d_render/layer_15** + + .. _class_ProjectSettings_layer_names/3d_render/layer_16: + +- :ref:`String` **layer_names/3d_render/layer_16** + + .. _class_ProjectSettings_layer_names/3d_render/layer_17: + +- :ref:`String` **layer_names/3d_render/layer_17** + + .. _class_ProjectSettings_layer_names/3d_render/layer_18: + +- :ref:`String` **layer_names/3d_render/layer_18** + + .. _class_ProjectSettings_layer_names/3d_render/layer_19: + +- :ref:`String` **layer_names/3d_render/layer_19** + + .. _class_ProjectSettings_layer_names/3d_render/layer_2: + +- :ref:`String` **layer_names/3d_render/layer_2** + + .. _class_ProjectSettings_layer_names/3d_render/layer_20: + +- :ref:`String` **layer_names/3d_render/layer_20** + + .. _class_ProjectSettings_layer_names/3d_render/layer_3: + +- :ref:`String` **layer_names/3d_render/layer_3** + + .. _class_ProjectSettings_layer_names/3d_render/layer_4: + +- :ref:`String` **layer_names/3d_render/layer_4** + + .. _class_ProjectSettings_layer_names/3d_render/layer_5: + +- :ref:`String` **layer_names/3d_render/layer_5** + + .. _class_ProjectSettings_layer_names/3d_render/layer_6: + +- :ref:`String` **layer_names/3d_render/layer_6** + + .. _class_ProjectSettings_layer_names/3d_render/layer_7: + +- :ref:`String` **layer_names/3d_render/layer_7** + + .. _class_ProjectSettings_layer_names/3d_render/layer_8: + +- :ref:`String` **layer_names/3d_render/layer_8** + + .. _class_ProjectSettings_layer_names/3d_render/layer_9: + +- :ref:`String` **layer_names/3d_render/layer_9** + + .. _class_ProjectSettings_locale/fallback: + +- :ref:`String` **locale/fallback** + + .. _class_ProjectSettings_locale/test: + +- :ref:`String` **locale/test** + + .. _class_ProjectSettings_logging/file_logging/enable_file_logging: + +- :ref:`bool` **logging/file_logging/enable_file_logging** - Log all output to a file. + + .. _class_ProjectSettings_logging/file_logging/log_path: + +- :ref:`String` **logging/file_logging/log_path** - Path to logs withint he project. Using an user:// based path is recommended. + + .. _class_ProjectSettings_logging/file_logging/max_log_files: + +- :ref:`int` **logging/file_logging/max_log_files** - Amount of log files (used for rotation)/ + + .. _class_ProjectSettings_memory/limits/message_queue/max_size_kb: + +- :ref:`int` **memory/limits/message_queue/max_size_kb** - 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_memory/limits/multithreaded_server/rid_pool_prealloc: + +- :ref:`int` **memory/limits/multithreaded_server/rid_pool_prealloc** - 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_network/limits/debugger_stdout/max_chars_per_second: + +- :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** - 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_network/limits/debugger_stdout/max_errors_per_frame: + +- :ref:`int` **network/limits/debugger_stdout/max_errors_per_frame** - 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_network/limits/debugger_stdout/max_messages_per_frame: + +- :ref:`int` **network/limits/debugger_stdout/max_messages_per_frame** - 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_network/limits/packet_peer_stream/max_buffer_po2: + +- :ref:`int` **network/limits/packet_peer_stream/max_buffer_po2** - Default size of packet peer stream for deserializing godot data. Over this size, data is dropped. + + .. _class_ProjectSettings_network/remote_fs/max_pages: + +- :ref:`int` **network/remote_fs/max_pages** - Maximum amount of pages used for remote filesystem (used by debugging). + + .. _class_ProjectSettings_network/remote_fs/page_read_ahead: + +- :ref:`int` **network/remote_fs/page_read_ahead** - Amount of read ahead used by remote filesystem. Improves latency. + + .. _class_ProjectSettings_network/remote_fs/page_size: + +- :ref:`int` **network/remote_fs/page_size** - Page size used by remote filesystem. + + .. _class_ProjectSettings_network/ssl/certificates: + +- :ref:`String` **network/ssl/certificates** - If your game or application uses HTTPS, a certificates file is needed. It must be set here. + + .. _class_ProjectSettings_node/name_casing: + +- :ref:`int` **node/name_casing** - When creating nodes names automatically, set the type of casing in this project. This is mostly an editor setting. + + .. _class_ProjectSettings_node/name_num_separator: + +- :ref:`int` **node/name_num_separator** - What to use to separate node name from number. This is mostly an editor setting. + + .. _class_ProjectSettings_physics/2d/physics_engine: + +- :ref:`String` **physics/2d/physics_engine** + + .. _class_ProjectSettings_physics/2d/thread_model: + +- :ref:`int` **physics/2d/thread_model** - Set 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_physics/3d/active_soft_world: + +- :ref:`bool` **physics/3d/active_soft_world** + + .. _class_ProjectSettings_physics/3d/physics_engine: + +- :ref:`String` **physics/3d/physics_engine** + + .. _class_ProjectSettings_physics/common/physics_fps: + +- :ref:`int` **physics/common/physics_fps** - Frames per second used in the physics. Physics always needs a fixed amount of frames per second. + + .. _class_ProjectSettings_physics/common/physics_jitter_fix: + +- :ref:`float` **physics/common/physics_jitter_fix** - Fix to improve physics jitter, specially on monitors where refresh rate is different than physics FPS. + + .. _class_ProjectSettings_rendering/environment/default_clear_color: + +- :ref:`Color` **rendering/environment/default_clear_color** - Default background clear color. + + .. _class_ProjectSettings_rendering/limits/buffers/blend_shape_max_buffer_size_kb: + +- :ref:`int` **rendering/limits/buffers/blend_shape_max_buffer_size_kb** - Max buffer size for blend shapes. Any blend shape bigger than this will not work. + + .. _class_ProjectSettings_rendering/limits/buffers/canvas_polygon_buffer_size_kb: + +- :ref:`int` **rendering/limits/buffers/canvas_polygon_buffer_size_kb** - Max buffer size for drawing polygons. Any polygon bigger than this will not work. + + .. _class_ProjectSettings_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb: + +- :ref:`int` **rendering/limits/buffers/canvas_polygon_index_buffer_size_kb** - Max index buffer size for drawing polygons. Any polygon bigger than this will not work. + + .. _class_ProjectSettings_rendering/limits/buffers/immediate_buffer_size_kb: + +- :ref:`int` **rendering/limits/buffers/immediate_buffer_size_kb** - Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. + + .. _class_ProjectSettings_rendering/limits/rendering/max_renderable_elements: + +- :ref:`int` **rendering/limits/rendering/max_renderable_elements** - 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 mesh themselves. + + .. _class_ProjectSettings_rendering/limits/time/time_rollover_secs: + +- :ref:`int` **rendering/limits/time/time_rollover_secs** - Shaders have a time variable that constantly increases. At some point it needs to be rolled back to zero to avoid numerical errors on shader animations. This setting specifies when. + + .. _class_ProjectSettings_rendering/quality/2d/use_pixel_snap: + +- :ref:`bool` **rendering/quality/2d/use_pixel_snap** - Force snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. + + .. _class_ProjectSettings_rendering/quality/depth_prepass/disable_for_vendors: + +- :ref:`String` **rendering/quality/depth_prepass/disable_for_vendors** - Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. + + .. _class_ProjectSettings_rendering/quality/depth_prepass/enable: + +- :ref:`bool` **rendering/quality/depth_prepass/enable** - Do a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. + + .. _class_ProjectSettings_rendering/quality/directional_shadow/size: + +- :ref:`int` **rendering/quality/directional_shadow/size** - Size in pixels of the directional shadow. + + .. _class_ProjectSettings_rendering/quality/directional_shadow/size.mobile: + +- :ref:`int` **rendering/quality/directional_shadow/size.mobile** + + .. _class_ProjectSettings_rendering/quality/driver/driver_name: + +- :ref:`String` **rendering/quality/driver/driver_name** + + .. _class_ProjectSettings_rendering/quality/filters/anisotropic_filter_level: + +- :ref:`int` **rendering/quality/filters/anisotropic_filter_level** - Maximum Anisotropic filter level used for textures when anisotropy enabled. + + .. _class_ProjectSettings_rendering/quality/filters/use_nearest_mipmap_filter: + +- :ref:`bool` **rendering/quality/filters/use_nearest_mipmap_filter** - Force to use nearest mipmap filtering when using mipmaps. This may increase performance in mobile as less memory bandwidth is used. + + .. _class_ProjectSettings_rendering/quality/intended_usage/framebuffer_allocation: + +- :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation** - Strategy used for framebuffer allocation. The simpler it is, the less memory it uses (but the least features it supports). + + .. _class_ProjectSettings_rendering/quality/intended_usage/framebuffer_allocation.mobile: + +- :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation.mobile** + + .. _class_ProjectSettings_rendering/quality/reflections/high_quality_ggx: + +- :ref:`bool` **rendering/quality/reflections/high_quality_ggx** - For reflection probes and panorama backgrounds (sky), use a high amount of samples to create ggx blurred versions (used for roughness). + + .. _class_ProjectSettings_rendering/quality/reflections/high_quality_ggx.mobile: + +- :ref:`bool` **rendering/quality/reflections/high_quality_ggx.mobile** + + .. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections: + +- :ref:`bool` **rendering/quality/reflections/texture_array_reflections** - For reflection probes and panorama backgrounds (sky), use a texure array instead of mipmaps. This reduces jitter noise on reflections, but costs more performance and memory. + + .. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections.mobile: + +- :ref:`bool` **rendering/quality/reflections/texture_array_reflections.mobile** + + .. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading: + +- :ref:`bool` **rendering/quality/shading/force_vertex_shading** - Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile. + + .. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading.mobile: + +- :ref:`bool` **rendering/quality/shading/force_vertex_shading.mobile** + + .. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_0_subdiv: + +- :ref:`int` **rendering/quality/shadow_atlas/quadrant_0_subdiv** - Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + + .. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_1_subdiv: + +- :ref:`int` **rendering/quality/shadow_atlas/quadrant_1_subdiv** - Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + + .. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_2_subdiv: + +- :ref:`int` **rendering/quality/shadow_atlas/quadrant_2_subdiv** - Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + + .. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_3_subdiv: + +- :ref:`int` **rendering/quality/shadow_atlas/quadrant_3_subdiv** - Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + + .. _class_ProjectSettings_rendering/quality/shadow_atlas/size: + +- :ref:`int` **rendering/quality/shadow_atlas/size** - Size for shadow atlas (used for point and omni lights). See documentation. + + .. _class_ProjectSettings_rendering/quality/shadow_atlas/size.mobile: + +- :ref:`int` **rendering/quality/shadow_atlas/size.mobile** + + .. _class_ProjectSettings_rendering/quality/shadows/filter_mode: + +- :ref:`int` **rendering/quality/shadows/filter_mode** - Shadow filter mode. The more complex the filter, the more memory bandwidth required. + + .. _class_ProjectSettings_rendering/quality/shadows/filter_mode.mobile: + +- :ref:`int` **rendering/quality/shadows/filter_mode.mobile** + + .. _class_ProjectSettings_rendering/quality/subsurface_scattering/follow_surface: + +- :ref:`bool` **rendering/quality/subsurface_scattering/follow_surface** - Improves quality of subsurface scattering, but cost significantly increases. + + .. _class_ProjectSettings_rendering/quality/subsurface_scattering/quality: + +- :ref:`int` **rendering/quality/subsurface_scattering/quality** - Quality setting for subsurface scaterring (samples taken). + + .. _class_ProjectSettings_rendering/quality/subsurface_scattering/scale: + +- :ref:`int` **rendering/quality/subsurface_scattering/scale** + + .. _class_ProjectSettings_rendering/quality/subsurface_scattering/weight_samples: + +- :ref:`bool` **rendering/quality/subsurface_scattering/weight_samples** - Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. + + .. _class_ProjectSettings_rendering/quality/voxel_cone_tracing/high_quality: + +- :ref:`bool` **rendering/quality/voxel_cone_tracing/high_quality** - Use high quality voxel cone tracing (looks better, but requires a higher end GPU). + + .. _class_ProjectSettings_rendering/threads/thread_model: + +- :ref:`int` **rendering/threads/thread_model** - Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc to the main thread can cause a bit more jitter. + + .. _class_ProjectSettings_rendering/vram_compression/import_etc: + +- :ref:`bool` **rendering/vram_compression/import_etc** - If the project uses this compression (usually low end mobile), texture importer will import these. + + .. _class_ProjectSettings_rendering/vram_compression/import_etc2: + +- :ref:`bool` **rendering/vram_compression/import_etc2** - If the project uses this compression (usually high end mobile), texture importer will import these. + + .. _class_ProjectSettings_rendering/vram_compression/import_pvrtc: + +- :ref:`bool` **rendering/vram_compression/import_pvrtc** - If the project uses this compression (usually iOS), texture importer will import these. + + .. _class_ProjectSettings_rendering/vram_compression/import_s3tc: + +- :ref:`bool` **rendering/vram_compression/import_s3tc** - If the project uses this compression (usually Desktop and Consoles), texture importer will import these. + + .. _class_ProjectSettings_script: + +- :ref:`Script` **script** + + Description ----------- diff --git a/classes/class_quat.rst b/classes/class_quat.rst index add448d2f..43b0fbfa6 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -73,6 +73,11 @@ Member Variables - :ref:`float` **z** - Z component of the quaternion. Default value: ``0`` +Numeric Constants +----------------- + +- **IDENTITY** = **Quat( 0, 0, 0, 1 )** + Description ----------- @@ -80,10 +85,14 @@ A unit quaternion used for representing 3D rotations. It is similar to :ref:`Basis`, which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. But due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating point errors. - - Quaternions need to be (re)normalized. +Tutorials +--------- + +- `#interpolating-with-quaternions <../tutorials/3d/using_transforms.html#interpolating-with-quaternions>`_ in :doc:`../tutorials/3d/using_transforms` +- :doc:`../tutorials/math/rotations` + Member Function Description --------------------------- diff --git a/classes/class_range.rst b/classes/class_range.rst index 26e8e27ba..562a9bbc7 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -34,13 +34,13 @@ Signals - **changed** **(** **)** -This signal is emitted when min, max, range or step change. +Emitted when :ref:`min_value`, :ref:`max_value`, :ref:`page`, or :ref:`step` change. .. _class_Range_value_changed: - **value_changed** **(** :ref:`float` value **)** -This signal is emitted when value changes. +Emitted when :ref:`value` changes. Member Variables @@ -48,11 +48,11 @@ Member Variables .. _class_Range_allow_greater: -- :ref:`bool` **allow_greater** +- :ref:`bool` **allow_greater** - If ``true`` :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. .. _class_Range_allow_lesser: -- :ref:`bool` **allow_lesser** +- :ref:`bool` **allow_lesser** - If ``true`` :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. .. _class_Range_exp_edit: @@ -60,11 +60,11 @@ Member Variables .. _class_Range_max_value: -- :ref:`float` **max_value** - Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: 100. +- :ref:`float` **max_value** - Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: ``100``. .. _class_Range_min_value: -- :ref:`float` **min_value** - Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: 0. +- :ref:`float` **min_value** - Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: ``0``. .. _class_Range_page: @@ -76,7 +76,7 @@ Member Variables .. _class_Range_rounded: -- :ref:`bool` **rounded** - If ``true``, ``value`` will always be rounded to the nearest integer. +- :ref:`bool` **rounded** - If ``true`` ``value`` will always be rounded to the nearest integer. Default value: ``false``. .. _class_Range_step: @@ -99,12 +99,12 @@ Member Function Description - void **share** **(** :ref:`Node` with **)** -Binds two Ranges together along with any Ranges previously grouped with either of them. When any of Range's member variables change, it will share the new value with all other Ranges in its group. +Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. .. _class_Range_unshare: - void **unshare** **(** **)** -Stop Range from sharing its member variables with any other Range. +Stop range from sharing its member variables with any other. diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 9a575acb1..83d4df7dd 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -68,6 +68,11 @@ Description Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. +Tutorials +--------- + +- :doc:`../tutorials/math/index` + Member Function Description --------------------------- @@ -87,6 +92,8 @@ Constructs a ``Rect2`` by x, y, width, and height. - :ref:`Rect2` **abs** **(** **)** +Returns a ``Rect2`` with equivalent position and area, modified so that the top-left corner is the origin and ``width`` and ``height`` are positive. + .. _class_Rect2_clip: - :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 333ffc267..523e5e653 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -9,7 +9,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`EditorScenePostImport`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`EditorInspectorPlugin`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`AnimationTrackEditPlugin`, :ref:`EditorScenePostImport`, :ref:`Expression`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`EditorInspectorPlugin`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`UPNP`, :ref:`EditorScript`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`UPNPDevice`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 3f563eaa2..83c02ed00 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -16,6 +16,14 @@ Brief Description Reference frame for GUI. +Member Variables +---------------- + + .. _class_ReferenceRect_border_color: + +- :ref:`Color` **border_color** + + Description ----------- diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index fc56872c3..e50212d62 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -79,3 +79,8 @@ enum **UpdateMode** - **UPDATE_ALWAYS** = **1** +Tutorials +--------- + +- :doc:`../tutorials/3d/reflection_probes` + diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 52dbfdebf..da904c240 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -9,7 +9,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`BakedLightmapData`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`AnimationNodeStateMachinePlayback`, :ref:`AudioStream`, :ref:`Sky`, :ref:`Theme`, :ref:`TextureLayered`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`VisualShaderNode`, :ref:`Curve2D`, :ref:`Image`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`Mesh`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`PhysicsMaterial`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`TextFile`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`BakedLightmapData`, :ref:`PolygonPathFinder`, :ref:`Translation`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`AnimationNode`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`AnimationNodeStateMachineTransition`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index df414a90b..6505477ab 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -9,7 +9,7 @@ ResourceImporter **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`ResourceImporterTheora`, :ref:`ResourceImporterOGGVorbis`, :ref:`ResourceImporterWebm` +**Inherited By:** :ref:`ResourceImporterOGGVorbis` **Category:** Core diff --git a/classes/class_resourceimportertheora.rst b/classes/class_resourceimportertheora.rst deleted file mode 100644 index a3ead509e..000000000 --- a/classes/class_resourceimportertheora.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceImporterTheora.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceImporterTheora: - -ResourceImporterTheora -====================== - -**Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceimporterwebm.rst b/classes/class_resourceimporterwebm.rst deleted file mode 100644 index 48e74f882..000000000 --- a/classes/class_resourceimporterwebm.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceImporterWebm.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceImporterWebm: - -ResourceImporterWebm -==================== - -**Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index df80ea85f..7c1d2d75a 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -19,6 +19,8 @@ Resource Loader. Member Functions ---------------- ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -26,6 +28,8 @@ Member Functions +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | @@ -41,6 +45,10 @@ Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScr Member Function Description --------------------------- +.. _class_ResourceLoader_exists: + +- :ref:`bool` **exists** **(** :ref:`String` path, :ref:`String` type_hint="" **)** + .. _class_ResourceLoader_get_dependencies: - :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** @@ -55,6 +63,10 @@ Return the list of recognized extensions for a resource type. - :ref:`bool` **has** **(** :ref:`String` path **)** +.. _class_ResourceLoader_has_cached: + +- :ref:`bool` **has_cached** **(** :ref:`String` path **)** + .. _class_ResourceLoader_load: - :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 025c8fbb7..1ecdc63c9 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -186,6 +186,11 @@ Rich text can contain custom text, fonts, images and some basic formatting. The Note that assignments to :ref:`bbcode_text` clear the tag stack and reconstruct it from the property's contents. Any edits made to :ref:`bbcode_text` will erase previous edits made from other manual sources such as :ref:`append_bbcode` and the ``push_*`` / :ref:`pop` methods. +Tutorials +--------- + +- :doc:`../tutorials/gui/bbcode_in_richtextlabel` + Member Function Description --------------------------- diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index b9573355a..d6f8bc377 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -24,6 +24,14 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` impulse **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` impulse **)** | @@ -156,6 +164,10 @@ Continuous collision detection tries to predict where a moving body will collide - :ref:`Mode` **mode** - The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. + .. _class_RigidBody_physics_material_override: + +- :ref:`PhysicsMaterial` **physics_material_override** + .. _class_RigidBody_sleeping: - :ref:`bool` **sleeping** - If ``true`` RigidBody is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. @@ -189,6 +201,11 @@ A RigidBody has 4 behavior :ref:`mode`\ s: Rigid, Static, If you need to override the default physics behavior, you can write a custom force integration. See :ref:`custom_integrator`. +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + Member Function Description --------------------------- @@ -198,6 +215,22 @@ Member Function Description Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but :ref:`set_use_custom_integrator` allows you to disable the default behavior and do fully custom force integration for a body. +.. _class_RigidBody_add_central_force: + +- void **add_central_force** **(** :ref:`Vector3` force **)** + +.. _class_RigidBody_add_force: + +- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** + +.. _class_RigidBody_add_torque: + +- void **add_torque** **(** :ref:`Vector3` torque **)** + +.. _class_RigidBody_apply_central_impulse: + +- void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** + .. _class_RigidBody_apply_impulse: - void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index fd2036dc8..31d1ff52f 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -22,10 +22,18 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** virtual | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_central_force` **(** :ref:`Vector2` force **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_torque` **(** :ref:`float` torque **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_torque_impulse` **(** :ref:`float` torque **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | @@ -140,6 +148,10 @@ Continuous collision detection tries to predict where a moving body will collide - :ref:`Mode` **mode** - The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. + .. _class_RigidBody2D_physics_material_override: + +- :ref:`PhysicsMaterial` **physics_material_override** + .. _class_RigidBody2D_sleeping: - :ref:`bool` **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`. @@ -190,18 +202,34 @@ Member Function Description Allows you to read and safely modify the simulation state for the object. Use this instead of Node._physics_process if you need to directly change the body's ``position`` or other physics properties. By default it works in addition to the usual physics behavior, but :ref:`custom_integrator` allows you to disable the default behavior and write custom force integration for a body. +.. _class_RigidBody2D_add_central_force: + +- void **add_central_force** **(** :ref:`Vector2` force **)** + .. _class_RigidBody2D_add_force: - void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. +.. _class_RigidBody2D_add_torque: + +- void **add_torque** **(** :ref:`float` torque **)** + +.. _class_RigidBody2D_apply_central_impulse: + +- void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** + .. _class_RigidBody2D_apply_impulse: - void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates. +.. _class_RigidBody2D_apply_torque_impulse: + +- void **apply_torque_impulse** **(** :ref:`float` torque **)** + .. _class_RigidBody2D_get_colliding_bodies: - :ref:`Array` **get_colliding_bodies** **(** **)** const diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst new file mode 100644 index 000000000..505083d05 --- /dev/null +++ b/classes/class_rootmotionview.rst @@ -0,0 +1,42 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the RootMotionView.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_RootMotionView: + +RootMotionView +============== + +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_RootMotionView_animation_path: + +- :ref:`NodePath` **animation_path** + + .. _class_RootMotionView_cell_size: + +- :ref:`float` **cell_size** + + .. _class_RootMotionView_color: + +- :ref:`Color` **color** + + .. _class_RootMotionView_radius: + +- :ref:`float` **radius** + + .. _class_RootMotionView_zero_y: + +- :ref:`bool` **zero_y** + + diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index d4b88abd5..8a7612bcc 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -221,19 +221,19 @@ enum **GroupCallFlags** enum **StretchMode** -- **STRETCH_MODE_DISABLED** = **0** -- **STRETCH_MODE_2D** = **1** -- **STRETCH_MODE_VIEWPORT** = **2** +- **STRETCH_MODE_DISABLED** = **0** --- No stretching. +- **STRETCH_MODE_2D** = **1** --- Render stretching in higher resolution (interpolated). +- **STRETCH_MODE_VIEWPORT** = **2** --- Keep the specified display resolution. No interpolation. Content may appear pixelated. .. _enum_SceneTree_StretchAspect: enum **StretchAspect** -- **STRETCH_ASPECT_IGNORE** = **0** -- **STRETCH_ASPECT_KEEP** = **1** -- **STRETCH_ASPECT_KEEP_WIDTH** = **2** -- **STRETCH_ASPECT_KEEP_HEIGHT** = **3** -- **STRETCH_ASPECT_EXPAND** = **4** +- **STRETCH_ASPECT_IGNORE** = **0** --- Fill the window with the content stretched to cover excessive space. Content may appear elongated. +- **STRETCH_ASPECT_KEEP** = **1** --- Retain the same aspect ratio by padding with black bars in either axes. No expansion of content. +- **STRETCH_ASPECT_KEEP_WIDTH** = **2** --- Expand vertically. Left/right black bars may appear if the window is too wide. +- **STRETCH_ASPECT_KEEP_HEIGHT** = **3** --- Expand horizontally. Top/bottom black bars may appear if the window is too tall. +- **STRETCH_ASPECT_EXPAND** = **4** --- Expand in both directions, retaining the same aspect ratio. No black bars. Description @@ -241,6 +241,12 @@ Description As one of the most important classes, the ``SceneTree`` manages the hierarchy of nodes in a scene as well as scenes themselves. Nodes can be added, retrieved and removed. The whole scene tree (and thus the current scene) can be paused. Scenes can be loaded, switched and reloaded. You can also use the SceneTree to organize your nodes into groups: every node can be assigned as many groups as you want to create, e.g. a "enemy" group. You can then iterate these groups or even call methods and set properties on all the group's members at once. +Tutorials +--------- + +- :doc:`../getting_started/step_by_step/scene_tree` +- :doc:`../tutorials/viewports/multiple_resolutions` + Member Function Description --------------------------- diff --git a/classes/class_script.rst b/classes/class_script.rst index 5688435f2..b41f34b82 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -54,6 +54,11 @@ A class stored as a resource. The script exends the functionality of all objects The 'new' method of a script subclass creates a new instance. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. +Tutorials +--------- + +- :doc:`../getting_started/step_by_step/scripting` + Member Function Description --------------------------- diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst new file mode 100644 index 000000000..cfa5818ae --- /dev/null +++ b/classes/class_scriptcreatedialog.rst @@ -0,0 +1,57 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ScriptCreateDialog.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ScriptCreateDialog: + +ScriptCreateDialog +================== + +**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +The Editor's popup dialog for creating new :ref:`Script` files. + +Member Functions +---------------- + ++-------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`config` **(** :ref:`String` inherits, :ref:`String` path **)** | ++-------+-----------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_ScriptCreateDialog_script_created: + +- **script_created** **(** :ref:`Object` script **)** + +Emitted when the user clicks the OK button. + + +Description +----------- + +The ScriptCreateDialog creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling a :ref:`popup`() method. + +:: + + func _ready(): + dialog.config("Node", "res://new_node.gd") # for in-engine types + dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # for script types + dialog.popup_centered() + +Member Function Description +--------------------------- + +.. _class_ScriptCreateDialog_config: + +- void **config** **(** :ref:`String` inherits, :ref:`String` path **)** + +Prefills required fields to configure the ScriptCreateDialog for use. + + diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 2a47b29d4..8154f134a 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -18,6 +18,15 @@ Brief Description A helper node for displaying scrollable elements (e.g. lists). +Member Functions +---------------- + ++--------------------------------------+---------------------------------------------------------------------------+ +| :ref:`HScrollBar` | :ref:`get_h_scrollbar` **(** **)** | ++--------------------------------------+---------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scrollbar` **(** **)** | ++--------------------------------------+---------------------------------------------------------------------------+ + Signals ------- @@ -63,3 +72,15 @@ Description A ScrollContainer node with a :ref:`Control` child and scrollbar child (HScrollbar, :ref:`VScrollBar`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension). +Member Function Description +--------------------------- + +.. _class_ScrollContainer_get_h_scrollbar: + +- :ref:`HScrollBar` **get_h_scrollbar** **(** **)** + +.. _class_ScrollContainer_get_v_scrollbar: + +- :ref:`VScrollBar` **get_v_scrollbar** **(** **)** + + diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 110a0e02c..d8ed965d9 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -9,6 +9,8 @@ Shader **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VisualShader` + **Category:** Core Brief Description @@ -54,6 +56,11 @@ Description This class allows you to define a custom shader program that can be used for various materials to render objects. +Tutorials +--------- + +- :doc:`../tutorials/shading/index` + Member Function Description --------------------------- diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 79307c83d..a6dcddd29 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -9,7 +9,7 @@ Shape **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`PlaneShape`, :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`RayShape`, :ref:`ConcavePolygonShape` +**Inherited By:** :ref:`CylinderShape`, :ref:`RayShape`, :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`PlaneShape`, :ref:`ConcavePolygonShape` **Category:** Core @@ -23,3 +23,8 @@ Description Base class for all 3D shape resources. All 3D shapes that inherit from this can be set into a :ref:`PhysicsBody` or :ref:`Area`. +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 956879d3f..2d1b0e8ce 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -9,7 +9,7 @@ Shape2D **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`RayShape2D`, :ref:`CapsuleShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` +**Inherited By:** :ref:`RayShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`CapsuleShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` **Category:** Core @@ -44,6 +44,11 @@ Description Base class for all 2D Shapes. All 2D shape types inherit from this. +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + Member Function Description --------------------------- diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index 7b027303b..6624782e9 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -62,6 +62,8 @@ Member Functions +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_ignore_animation` **(** :ref:`int` bone, :ref:`bool` ignore **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | @@ -83,6 +85,10 @@ Description Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see :ref:`Animation`). Skeleton will support rag doll dynamics in the future. +The overall transform of a bone with respect to the skeleton is determined by the following hierarchical order: rest pose, custom pose and pose. + +Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone. + Member Function Description --------------------------- @@ -120,15 +126,19 @@ Return the amount of bones in the skeleton. - :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const +Return the custom pose of the specified bone. Custom pose is applied on top of the rest pose. + .. _class_Skeleton_get_bone_global_pose: - :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const +Return the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. + .. _class_Skeleton_get_bone_name: - :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const -Return the name of the bone at index "index" +Return the name of the bone at index "index". .. _class_Skeleton_get_bone_parent: @@ -140,7 +150,7 @@ Return the bone index which is the parent of the bone at "bone_idx". If -1, then - :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const -Return the pose transform for bone "bone_idx". +Return the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. .. _class_Skeleton_get_bone_rest: @@ -152,6 +162,8 @@ Return the rest transform for a bone "bone_idx". - :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const +Return the combination of custom pose and pose. The returned transform is in skeleton's reference frame. + .. _class_Skeleton_get_bound_child_nodes_to_bone: - :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const @@ -190,6 +202,10 @@ Deprecated soon. - void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** +.. _class_Skeleton_set_bone_ignore_animation: + +- void **set_bone_ignore_animation** **(** :ref:`int` bone, :ref:`bool` ignore **)** + .. _class_Skeleton_set_bone_parent: - void **set_bone_parent** **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 816ed42f8..0431c1f15 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -19,20 +19,20 @@ Brief Description Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Bone2D` | :ref:`get_bone` **(** :ref:`int` arg0 **)** | -+------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------+ +| :ref:`Bone2D` | :ref:`get_bone` **(** :ref:`int` idx **)** | ++------------------------------+----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_count` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_Skeleton2D_get_bone: -- :ref:`Bone2D` **get_bone** **(** :ref:`int` arg0 **)** +- :ref:`Bone2D` **get_bone** **(** :ref:`int` idx **)** .. _class_Skeleton2D_get_bone_count: diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst new file mode 100644 index 000000000..4493acf3c --- /dev/null +++ b/classes/class_skeletonik.rst @@ -0,0 +1,91 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the SkeletonIK.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_SkeletonIK: + +SkeletonIK +========== + +**Inherits:** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Skeleton` | :ref:`get_parent_skeleton` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_running` **(** **)** | ++----------------------------------+-----------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** :ref:`bool` one_time=false **)** | ++----------------------------------+-----------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------------+-----------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_SkeletonIK_interpolation: + +- :ref:`float` **interpolation** + + .. _class_SkeletonIK_magnet: + +- :ref:`Vector3` **magnet** + + .. _class_SkeletonIK_max_iterations: + +- :ref:`int` **max_iterations** + + .. _class_SkeletonIK_min_distance: + +- :ref:`float` **min_distance** + + .. _class_SkeletonIK_root_bone: + +- :ref:`String` **root_bone** + + .. _class_SkeletonIK_target: + +- :ref:`Transform` **target** + + .. _class_SkeletonIK_target_node: + +- :ref:`NodePath` **target_node** + + .. _class_SkeletonIK_tip_bone: + +- :ref:`String` **tip_bone** + + .. _class_SkeletonIK_use_magnet: + +- :ref:`bool` **use_magnet** + + +Member Function Description +--------------------------- + +.. _class_SkeletonIK_get_parent_skeleton: + +- :ref:`Skeleton` **get_parent_skeleton** **(** **)** const + +.. _class_SkeletonIK_is_running: + +- :ref:`bool` **is_running** **(** **)** + +.. _class_SkeletonIK_start: + +- void **start** **(** :ref:`bool` one_time=false **)** + +.. _class_SkeletonIK_stop: + +- void **stop** **(** **)** + + diff --git a/classes/class_slider.rst b/classes/class_slider.rst index bc7231a47..59e626e98 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -29,6 +29,10 @@ Member Variables - :ref:`FocusMode` **focus_mode** + .. _class_Slider_scrollable: + +- :ref:`bool` **scrollable** + .. _class_Slider_tick_count: - :ref:`int` **tick_count** diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst new file mode 100644 index 000000000..6b4479d2d --- /dev/null +++ b/classes/class_softbody.rst @@ -0,0 +1,127 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the SoftBody.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_SoftBody: + +SoftBody +======== + +**Inherits:** :ref:`MeshInstance` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_SoftBody_areaAngular_stiffness: + +- :ref:`float` **areaAngular_stiffness** + + .. _class_SoftBody_collision_layer: + +- :ref:`int` **collision_layer** + + .. _class_SoftBody_collision_mask: + +- :ref:`int` **collision_mask** + + .. _class_SoftBody_damping_coefficient: + +- :ref:`float` **damping_coefficient** + + .. _class_SoftBody_drag_coefficient: + +- :ref:`float` **drag_coefficient** + + .. _class_SoftBody_linear_stiffness: + +- :ref:`float` **linear_stiffness** + + .. _class_SoftBody_parent_collision_ignore: + +- :ref:`NodePath` **parent_collision_ignore** + + .. _class_SoftBody_pose_matching_coefficient: + +- :ref:`float` **pose_matching_coefficient** + + .. _class_SoftBody_pressure_coefficient: + +- :ref:`float` **pressure_coefficient** + + .. _class_SoftBody_simulation_precision: + +- :ref:`int` **simulation_precision** + + .. _class_SoftBody_total_mass: + +- :ref:`float` **total_mass** + + .. _class_SoftBody_volume_stiffness: + +- :ref:`float` **volume_stiffness** + + +Member Function Description +--------------------------- + +.. _class_SoftBody_add_collision_exception_with: + +- void **add_collision_exception_with** **(** :ref:`Node` body **)** + +.. _class_SoftBody_get_collision_layer_bit: + +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const + +.. _class_SoftBody_get_collision_mask_bit: + +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const + +.. _class_SoftBody_is_ray_pickable: + +- :ref:`bool` **is_ray_pickable** **(** **)** const + +.. _class_SoftBody_remove_collision_exception_with: + +- void **remove_collision_exception_with** **(** :ref:`Node` body **)** + +.. _class_SoftBody_set_collision_layer_bit: + +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + +.. _class_SoftBody_set_collision_mask_bit: + +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + +.. _class_SoftBody_set_ray_pickable: + +- void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** + + diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index bbdc74288..f1e934a8e 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -9,7 +9,7 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`ARVRController`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`OrientedPathFollow`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`SpringArm`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`OrientedPathFollow`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` **Category:** Core @@ -36,6 +36,8 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scale_disabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | @@ -62,6 +64,8 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_scale` **(** :ref:`bool` disable **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_identity` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | @@ -108,8 +112,6 @@ Member Variables - :ref:`Vector3` **rotation** - Rotation part of the local transformation, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle), in radians. - - Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three indepdent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3` data structure not because the rotation is a vector, but only because :ref:`Vector3` exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. .. _class_Spatial_rotation_degrees: @@ -148,10 +150,13 @@ Description Most basic 3D game object, with a 3D :ref:`Transform` and visibility settings. All other 3D game objects inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project. - - Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the Spatial object is set as top level. Affine operations in this coordinate system correspond to direct affine operations on the Spatial's transform. The word local below refers to this coordinate system. The coordinate system that is attached to the Spatial object itself is referred to as object-local coordinate system. +Tutorials +--------- + +- :doc:`../tutorials/3d/introduction_to_3d` + Member Function Description --------------------------- @@ -195,6 +200,10 @@ Disables rendering of this node. Change Spatial Visible property to false. Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default. +.. _class_Spatial_is_scale_disabled: + +- :ref:`bool` **is_scale_disabled** **(** **)** const + .. _class_Spatial_is_set_as_toplevel: - :ref:`bool` **is_set_as_toplevel** **(** **)** const @@ -277,6 +286,10 @@ Scales the local transformation by given 3D scale factors in object-local coordi Makes the node ignore its parents transformations. Node transformations are only in global space. +.. _class_Spatial_set_disable_scale: + +- void **set_disable_scale** **(** :ref:`bool` disable **)** + .. _class_Spatial_set_identity: - void **set_identity** **(** **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index e0b411007..51c9835ac 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -163,10 +163,18 @@ Member Variables - :ref:`bool` **flags_albedo_tex_force_srgb** + .. _class_SpatialMaterial_flags_disable_ambient_light: + +- :ref:`bool` **flags_disable_ambient_light** + .. _class_SpatialMaterial_flags_do_not_receive_shadows: - :ref:`bool` **flags_do_not_receive_shadows** + .. _class_SpatialMaterial_flags_ensure_correct_normals: + +- :ref:`bool` **flags_ensure_correct_normals** + .. _class_SpatialMaterial_flags_fixed_size: - :ref:`bool` **flags_fixed_size** @@ -227,6 +235,10 @@ Member Variables - :ref:`float` **params_alpha_scissor_threshold** + .. _class_SpatialMaterial_params_billboard_keep_scale: + +- :ref:`bool` **params_billboard_keep_scale** + .. _class_SpatialMaterial_params_billboard_mode: - :ref:`BillboardMode` **params_billboard_mode** @@ -488,15 +500,18 @@ enum **Flags** - **FLAG_SRGB_VERTEX_COLOR** = **4** - **FLAG_USE_POINT_SIZE** = **5** - **FLAG_FIXED_SIZE** = **6** -- **FLAG_UV1_USE_TRIPLANAR** = **7** -- **FLAG_UV2_USE_TRIPLANAR** = **8** -- **FLAG_AO_ON_UV2** = **10** -- **FLAG_EMISSION_ON_UV2** = **11** -- **FLAG_USE_ALPHA_SCISSOR** = **12** -- **FLAG_TRIPLANAR_USE_WORLD** = **9** -- **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = **13** -- **FLAG_DONT_RECEIVE_SHADOWS** = **14** -- **FLAG_MAX** = **15** +- **FLAG_BILLBOARD_KEEP_SCALE** = **7** +- **FLAG_UV1_USE_TRIPLANAR** = **8** +- **FLAG_UV2_USE_TRIPLANAR** = **9** +- **FLAG_AO_ON_UV2** = **11** +- **FLAG_EMISSION_ON_UV2** = **12** +- **FLAG_USE_ALPHA_SCISSOR** = **13** +- **FLAG_TRIPLANAR_USE_WORLD** = **10** +- **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = **14** +- **FLAG_DONT_RECEIVE_SHADOWS** = **15** +- **FLAG_DISABLE_AMBIENT_LIGHT** = **17** +- **FLAG_ENSURE_CORRECT_NORMALS** = **16** +- **FLAG_MAX** = **18** .. _enum_SpatialMaterial_BlendMode: @@ -544,3 +559,8 @@ enum **EmissionOperator** - **EMISSION_OP_MULTIPLY** = **1** +Tutorials +--------- + +- :doc:`../tutorials/3d/spatial_material` + diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index 5b0d42c1e..db61eb4e1 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -41,3 +41,8 @@ Description A SpotLight light is a type of :ref:`Light` node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light`. TODO: Image of a spotlight. +Tutorials +--------- + +- :doc:`../tutorials/3d/lights_and_shadows` + diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst new file mode 100644 index 000000000..1030bd6df --- /dev/null +++ b/classes/class_springarm.rst @@ -0,0 +1,71 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the SpringArm.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_SpringArm: + +SpringArm +========= + +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_excluded_object` **(** :ref:`RID` RID **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_excluded_objects` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_hit_length` **(** **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_excluded_object` **(** :ref:`RID` RID **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_SpringArm_collision_mask: + +- :ref:`int` **collision_mask** + + .. _class_SpringArm_margin: + +- :ref:`float` **margin** + + .. _class_SpringArm_shape: + +- :ref:`Shape` **shape** + + .. _class_SpringArm_spring_length: + +- :ref:`float` **spring_length** + + +Member Function Description +--------------------------- + +.. _class_SpringArm_add_excluded_object: + +- void **add_excluded_object** **(** :ref:`RID` RID **)** + +.. _class_SpringArm_clear_excluded_objects: + +- void **clear_excluded_objects** **(** **)** + +.. _class_SpringArm_get_hit_length: + +- :ref:`float` **get_hit_length** **(** **)** + +.. _class_SpringArm_remove_excluded_object: + +- :ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** + + diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 22c1e4bfd..c5dc8fe63 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -21,9 +21,11 @@ Brief Description Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------+ ++------------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -106,6 +108,10 @@ A node that displays 2D texture information in a 3D environment. Member Function Description --------------------------- +.. _class_SpriteBase3D_generate_triangle_mesh: + +- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const + .. _class_SpriteBase3D_get_item_rect: - :ref:`Rect2` **get_item_rect** **(** **)** const diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index e0600b3c3..45ed64182 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -19,37 +19,39 @@ Sprite frame library for AnimatedSprite. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_animation` **(** :ref:`String` anim **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` anim **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_animation` **(** :ref:`String` anim **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` anim **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all` **(** **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -71,7 +73,7 @@ Member Function Description - void **add_animation** **(** :ref:`String` anim **)** -Adds a new animation to the the library. +Adds a new animation to the library. .. _class_SpriteFrames_add_frame: @@ -97,6 +99,12 @@ Removes all animations. A "default" animation will be created. If ``true`` the given animation will loop. +.. _class_SpriteFrames_get_animation_names: + +- :ref:`PoolStringArray` **get_animation_names** **(** **)** const + +Returns an array containing the names associated to each animation. Values are placed in alphabetical order. + .. _class_SpriteFrames_get_animation_speed: - :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 87418b4d9..51bf803ef 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -35,6 +35,10 @@ Member Variables - :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (full friction). + .. _class_StaticBody_physics_material_override: + +- :ref:`PhysicsMaterial` **physics_material_override** + Description ----------- diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 9bec741ac..d6c9a52bb 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -35,6 +35,10 @@ Member Variables - :ref:`float` **friction** - The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). + .. _class_StaticBody2D_physics_material_override: + +- :ref:`PhysicsMaterial` **physics_material_override** + Description ----------- diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 03cd5097d..dfce3ded4 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -9,7 +9,7 @@ StreamPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP` +**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP`, :ref:`StreamPeerGDNative` **Category:** Core diff --git a/classes/class_streampeergdnative.rst b/classes/class_streampeergdnative.rst new file mode 100644 index 000000000..e48948812 --- /dev/null +++ b/classes/class_streampeergdnative.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the StreamPeerGDNative.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_StreamPeerGDNative: + +StreamPeerGDNative +================== + +**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 850f5ba3e..efa51bb6a 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -20,7 +20,7 @@ Member Functions ---------------- +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | +| :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` base **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -31,6 +31,14 @@ Member Functions | void | :ref:`poll` **(** **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + + .. _class_StreamPeerSSL_blocking_handshake: + +- :ref:`bool` **blocking_handshake** + + Enums ----- @@ -39,9 +47,9 @@ Enums enum **Status** - **STATUS_DISCONNECTED** = **0** --- A status representing a ``StreamPeerSSL`` that is disconnected. -- **STATUS_CONNECTED** = **1** --- A status representing a ``StreamPeerSSL`` that is connected to a host. -- **STATUS_ERROR_NO_CERTIFICATE** = **2** --- An errot status that shows the peer did not present a SSL certificate and validation was requested. -- **STATUS_ERROR_HOSTNAME_MISMATCH** = **3** --- An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. +- **STATUS_CONNECTED** = **2** --- A status representing a ``StreamPeerSSL`` that is connected to a host. +- **STATUS_ERROR** = **3** +- **STATUS_ERROR_HOSTNAME_MISMATCH** = **4** --- An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. Description @@ -49,12 +57,17 @@ Description SSL Stream peer. This object can be used to connect to SSL servers. +Tutorials +--------- + +- :doc:`../tutorials/networking/ssl_certificates` + Member Function Description --------------------------- .. _class_StreamPeerSSL_accept_stream: -- :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` stream **)** +- :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` base **)** .. _class_StreamPeerSSL_connect_to_stream: diff --git a/classes/class_string.rst b/classes/class_string.rst index a033dda4a..197f6eaba 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -661,7 +661,9 @@ Returns the right side of the string from a given position. - :ref:`PoolStringArray` **rsplit** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** -Splits the string by a ``divisor`` string and returns an array of the substrings, starting from right. Example "One,Two,Three" will return "One","Two","Three" if split by ",". +Splits the string by a ``divisor`` string and returns an array of the substrings, starting from right. + +**Example:** "One,Two,Three" will return "One","Two","Three" if split by ",". If ``maxsplit`` is specified, then it is number of splits to do, default is 0 which splits all the items. @@ -691,7 +693,9 @@ Returns the similarity index of the text compared to this string. 1 means totall - :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** -Splits the string by a divisor string and returns an array of the substrings. Example "One,Two,Three" will return "One","Two","Three" if split by ",". +Splits the string by a divisor string and returns an array of the substrings. + +**Example:** "One,Two,Three" will return "One","Two","Three" if split by ",". If ``maxsplit`` is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) @@ -699,7 +703,9 @@ If ``maxsplit`` is given, at most maxsplit number of splits occur, and the remai - :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** -Splits the string in floats by using a divisor string and returns an array of the substrings. Example "1,2.5,3" will return 1,2.5,3 if split by ",". +Splits the string in floats by using a divisor string and returns an array of the substrings. + +**Example:** "1,2.5,3" will return 1,2.5,3 if split by ",". .. _class_String_strip_edges: diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index f41e3c60e..822ae5f95 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -23,9 +23,13 @@ Member Variables - :ref:`Color` **color** - .. _class_StyleBoxLine_grow: + .. _class_StyleBoxLine_grow_begin: -- :ref:`float` **grow** +- :ref:`float` **grow_begin** + + .. _class_StyleBoxLine_grow_end: + +- :ref:`float` **grow_end** .. _class_StyleBoxLine_thickness: diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 8de780517..70ae6f798 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -50,7 +50,7 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97792 **)** | +| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -173,7 +173,7 @@ Clear all information passed into the surface tool so far. .. _class_SurfaceTool_commit: -- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97792 **)** +- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 8d79fb3e9..a5f1025a3 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -7,7 +7,7 @@ TabContainer ============ -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index c8f80d333..96e551b13 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -26,6 +26,8 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_count` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | @@ -44,6 +46,8 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_with_rmb` **(** :ref:`bool` enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | @@ -147,6 +151,10 @@ Member Function Description - :ref:`bool` **get_offset_buttons_visible** **(** **)** const +.. _class_Tabs_get_select_with_rmb: + +- :ref:`bool` **get_select_with_rmb** **(** **)** const + .. _class_Tabs_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const @@ -187,6 +195,10 @@ Rearrange tab. - void **remove_tab** **(** :ref:`int` tab_idx **)** +.. _class_Tabs_set_select_with_rmb: + +- void **set_select_with_rmb** **(** :ref:`bool` enabled **)** + .. _class_Tabs_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index adb764419..8e7e82f94 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -48,6 +48,8 @@ Member Functions +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fold_line` **(** :ref:`int` line **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_breakpoints` **(** **)** const | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | @@ -84,6 +86,8 @@ Member Functions +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`redo` **(** **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_breakpoints` **(** **)** | ++------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | @@ -134,6 +138,10 @@ Emitted when the text changes. Member Variables ---------------- + .. _class_TextEdit_breakpoint_gutter: + +- :ref:`bool` **breakpoint_gutter** - If ``true`` the breakpoint gutter is visible. + .. _class_TextEdit_caret_blink: - :ref:`bool` **caret_blink** - If ``true`` the caret (visual cursor) blinks. @@ -309,6 +317,12 @@ Clears the current selection. - void **fold_line** **(** :ref:`int` line **)** +.. _class_TextEdit_get_breakpoints: + +- :ref:`Array` **get_breakpoints** **(** **)** const + +Return an array containing the line number of each breakpoint. + .. _class_TextEdit_get_keyword_color: - :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** const @@ -403,6 +417,12 @@ Paste the current selection. Perform redo operation. +.. _class_TextEdit_remove_breakpoints: + +- void **remove_breakpoints** **(** **)** + +Removes all the breakpoints (without firing "breakpoint_toggled" signal). + .. _class_TextEdit_search: - :ref:`PoolIntArray` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const diff --git a/classes/class_textfile.rst b/classes/class_textfile.rst new file mode 100644 index 000000000..088f5860b --- /dev/null +++ b/classes/class_textfile.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the TextFile.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_TextFile: + +TextFile +======== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_texture.rst b/classes/class_texture.rst index a24acd5f2..19db5b93d 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -9,7 +9,7 @@ Texture **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`ProxyTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` +**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`ProxyTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`AnimatedTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` **Category:** Core @@ -63,7 +63,7 @@ enum **Flags** More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. - **FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space. - **FLAG_MIRRORED_REPEAT** = **32** --- Repeats texture with alternate sections mirrored. -- **FLAG_VIDEO_SURFACE** = **4096** --- Texture is a video surface. +- **FLAG_VIDEO_SURFACE** = **2048** --- Texture is a video surface. Description @@ -71,6 +71,8 @@ Description A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite` or GUI :ref:`Control`. +Textures are often created by loading them from a file. See :ref:`@GDScript.load`. + Member Function Description --------------------------- diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst new file mode 100644 index 000000000..259c97ed9 --- /dev/null +++ b/classes/class_texture3d.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Texture3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Texture3D: + +Texture3D +========= + +**Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_texturearray.rst b/classes/class_texturearray.rst new file mode 100644 index 000000000..23b974f10 --- /dev/null +++ b/classes/class_texturearray.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the TextureArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_TextureArray: + +TextureArray +============ + +**Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst new file mode 100644 index 000000000..408fe0fbe --- /dev/null +++ b/classes/class_texturelayered.rst @@ -0,0 +1,102 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the TextureLayered.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_TextureLayered: + +TextureLayered +============== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`TextureArray`, :ref:`Texture3D` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_depth` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Format` | :ref:`get_format` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data_partial` **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_data` **(** :ref:`Image` image, :ref:`int` layer **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_TextureLayered_data: + +- :ref:`Dictionary` **data** + + .. _class_TextureLayered_flags: + +- :ref:`int` **flags** + + +Enums +----- + + .. _enum_TextureLayered_Flags: + +enum **Flags** + +- **FLAG_MIPMAPS** = **1** +- **FLAG_REPEAT** = **2** +- **FLAG_FILTER** = **4** +- **FLAGS_DEFAULT** = **4** + + +Member Function Description +--------------------------- + +.. _class_TextureLayered_create: + +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** + +.. _class_TextureLayered_get_depth: + +- :ref:`int` **get_depth** **(** **)** const + +.. _class_TextureLayered_get_format: + +- :ref:`Format` **get_format** **(** **)** const + +.. _class_TextureLayered_get_height: + +- :ref:`int` **get_height** **(** **)** const + +.. _class_TextureLayered_get_layer_data: + +- :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const + +.. _class_TextureLayered_get_width: + +- :ref:`int` **get_width** **(** **)** const + +.. _class_TextureLayered_set_data_partial: + +- void **set_data_partial** **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** + +.. _class_TextureLayered_set_layer_data: + +- void **set_layer_data** **(** :ref:`Image` image, :ref:`int` layer **)** + + diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 9e68b2585..4d51ef8c8 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -97,6 +97,9 @@ enum **FillMode** - **FILL_BOTTOM_TO_TOP** = **3** --- The :ref:`texture_progress` fills from bottom to top. - **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The :ref:`texture_progress` fills clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to refine its behavior. - **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The :ref:`texture_progress` fills counter-clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to refine its behavior. +- **FILL_BILINEAR_LEFT_AND_RIGHT** = **6** +- **FILL_BILINEAR_TOP_AND_BOTTOM** = **7** +- **FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE** = **8** Description diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 3e3c2dad2..d4fd82798 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -48,6 +48,8 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_celld` **(** :ref:`Vector2` position, :ref:`Dictionary` data **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | @@ -58,6 +60,8 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_bitmask_region` **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_dirty_quadrants` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -173,6 +177,11 @@ Description Node for 2D tile-based maps. Tilemaps use a :ref:`TileSet` which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps. +Tutorials +--------- + +- :doc:`../tutorials/2d/using_tilemaps` + Member Function Description --------------------------- @@ -216,7 +225,7 @@ Returns ``true`` if the given collision mask bit is set. - :ref:`Array` **get_used_cells** **(** **)** const -Returns an array of all cells containing a tile from the tileset (i.e. a tile index different from ``-1``). +Returns a :ref:`Vector2` array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from ``-1``). .. _class_TileMap_get_used_cells_by_id: @@ -266,6 +275,14 @@ An index of ``-1`` clears the cell. Optionally, the tile can also be flipped, transposed, or given autotile coordinates. +Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons. + +If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. + +.. _class_TileMap_set_celld: + +- void **set_celld** **(** :ref:`Vector2` position, :ref:`Dictionary` data **)** + .. _class_TileMap_set_cellv: - void **set_cellv** **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** @@ -276,6 +293,10 @@ An index of ``-1`` clears the cell. Optionally, the tile can also be flipped or transposed. +Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons. + +If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. + .. _class_TileMap_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** @@ -302,6 +323,12 @@ Applies autotiling rules to the cells in the given region (specified by grid-bas Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap. +.. _class_TileMap_update_dirty_quadrants: + +- void **update_dirty_quadrants** **(** **)** + +Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified. + .. _class_TileMap_world_to_map: - :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index e4669ff6a..77b47c739 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -46,6 +46,8 @@ Member Functions +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`tile_get_modulate` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | @@ -80,6 +82,8 @@ Member Functions +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_modulate` **(** :ref:`int` id, :ref:`Color` color **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | @@ -126,7 +130,7 @@ enum **TileMode** - **SINGLE_TILE** = **0** - **AUTO_TILE** = **1** -- **ANIMATED_TILE** = **2** +- **ATLAS_TILE** = **2** .. _enum_TileSet_AutotileBindings: @@ -172,37 +176,37 @@ Member Function Description - void **clear** **(** **)** -Clear all tiles. +Clears all tiles. .. _class_TileSet_create_tile: - void **create_tile** **(** :ref:`int` id **)** -Create a new tile which will be referenced by the given ID. +Creates a new tile which will be referenced by the given ID. .. _class_TileSet_find_tile_by_name: - :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const -Find the first tile matching the given name. +Returns the first tile matching the given name. .. _class_TileSet_get_last_unused_tile_id: - :ref:`int` **get_last_unused_tile_id** **(** **)** const -Return the ID following the last currently used ID, useful when creating a new tile. +Returns the ID following the last currently used ID, useful when creating a new tile. .. _class_TileSet_get_tiles_ids: - :ref:`Array` **get_tiles_ids** **(** **)** const -Return an array of all currently used tile IDs. +Returns an array of all currently used tile IDs. .. _class_TileSet_remove_tile: - void **remove_tile** **(** :ref:`int` id **)** -Remove the tile referenced by the given ID. +Removes the tile referenced by the given ID. .. _class_TileSet_tile_add_shape: @@ -212,31 +216,35 @@ Remove the tile referenced by the given ID. - :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const -Return the light occluder of the tile. +Returns the light occluder of the tile. .. _class_TileSet_tile_get_material: - :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const -Return the material of the tile. +Returns the material of the tile. + +.. _class_TileSet_tile_get_modulate: + +- :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** const .. _class_TileSet_tile_get_name: - :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const -Return the name of the tile. +Returns the name of the tile. .. _class_TileSet_tile_get_navigation_polygon: - :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const -Return the navigation polygon of the tile. +Returns the navigation polygon of the tile. .. _class_TileSet_tile_get_navigation_polygon_offset: - :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** const -Return the offset of the tile's navigation polygon. +Returns the offset of the tile's navigation polygon. .. _class_TileSet_tile_get_normal_map: @@ -246,13 +254,13 @@ Return the offset of the tile's navigation polygon. - :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const -Return the offset of the tile's light occluder. +Returns the offset of the tile's light occluder. .. _class_TileSet_tile_get_region: - :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const -Return the tile sub-region in the texture. +Returns the tile sub-region in the texture. .. _class_TileSet_tile_get_shape: @@ -274,19 +282,19 @@ Return the tile sub-region in the texture. - :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const -Return the array of shapes of the tile. +Returns the array of shapes of the tile. .. _class_TileSet_tile_get_texture: - :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const -Return the texture of the tile. +Returns the texture of the tile. .. _class_TileSet_tile_get_texture_offset: - :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const -Return the texture offset of the tile. +Returns the texture offset of the tile. .. _class_TileSet_tile_get_tile_mode: @@ -300,36 +308,44 @@ Return the texture offset of the tile. - void **tile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** -Set a light occluder for the tile. +Sets a light occluder for the tile. .. _class_TileSet_tile_set_material: - void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** -Set the material of the tile. +Sets the tile's material. + +.. _class_TileSet_tile_set_modulate: + +- void **tile_set_modulate** **(** :ref:`int` id, :ref:`Color` color **)** + +Sets the tile's modulation color. .. _class_TileSet_tile_set_name: - void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** -Set the name of the tile, for descriptive purposes. +Sets the tile's name. .. _class_TileSet_tile_set_navigation_polygon: - void **tile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** -Set a navigation polygon for the tile. +Sets the tile's navigation polygon. .. _class_TileSet_tile_set_navigation_polygon_offset: - void **tile_set_navigation_polygon_offset** **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** -Set an offset for the tile's navigation polygon. +Sets an offset for the tile's navigation polygon. .. _class_TileSet_tile_set_normal_map: - void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** +Sets the tile's normal map texture. + .. _class_TileSet_tile_set_occluder_offset: - void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** @@ -340,7 +356,7 @@ Set an offset for the tile's light occluder. - void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** -Set the tile sub-region in the texture. This is common in texture atlases. +Set the tile's sub-region in the texture. This is common in texture atlases. .. _class_TileSet_tile_set_shape: @@ -358,26 +374,30 @@ Set the tile sub-region in the texture. This is common in texture atlases. - void **tile_set_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** -Set an array of shapes for the tile, enabling physics to collide with it. +Sets an array of shapes for the tile, enabling collision. .. _class_TileSet_tile_set_texture: - void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** -Set the texture of the tile. +Sets the tile's texture. .. _class_TileSet_tile_set_texture_offset: - void **tile_set_texture_offset** **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** -Set the texture offset of the tile. +Sets the tile's texture offset. .. _class_TileSet_tile_set_tile_mode: - void **tile_set_tile_mode** **(** :ref:`int` id, :ref:`TileMode` tilemode **)** +Sets the tile's :ref:`TileMode`. + .. _class_TileSet_tile_set_z_index: - void **tile_set_z_index** **(** :ref:`int` id, :ref:`int` z_index **)** +Sets the tile's drawing index. + diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index b5b65483d..ecca850a6 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -21,8 +21,6 @@ Description This is a helper class to generate a flat :ref:`Button` (see :ref:`Button.set_flat`), creating a ToolButton is equivalent to: - - :: var btn = Button.new() diff --git a/classes/class_transform.rst b/classes/class_transform.rst index bdff20919..8491790ce 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -61,11 +61,25 @@ Member Variables - :ref:`Vector3` **origin** - The translation offset of the transform. +Numeric Constants +----------------- + +- **IDENTITY** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** +- **FLIP_X** = **Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** +- **FLIP_Y** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** +- **FLIP_Z** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** + Description ----------- Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a :ref:`Basis` "basis" and an :ref:`Vector3` "origin". It is similar to a 3x4 matrix. +Tutorials +--------- + +- :doc:`../tutorials/math/index` +- :doc:`../tutorials/3d/using_transforms` + Member Function Description --------------------------- diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 53120a5bc..1f7b58f7c 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -69,6 +69,13 @@ Member Variables - :ref:`Vector2` **y** - The Y axis of 2x2 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. +Numeric Constants +----------------- + +- **IDENTITY** = **Transform2D( 1, 0, 0, 1, 0, 0 )** +- **FLIP_X** = **Transform2D( -1, 0, 0, 1, 0, 0 )** +- **FLIP_Y** = **Transform2D( 1, 0, 0, -1, 0, 0 )** + Description ----------- diff --git a/classes/class_tree.rst b/classes/class_tree.rst index e1a93a82a..4767a394b 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -174,7 +174,7 @@ Member Variables .. _class_Tree_drop_mode_flags: -- :ref:`int` **drop_mode_flags** - The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. +- :ref:`int` **drop_mode_flags** - The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once dropping is done, reverts to ``DROP_MODE_DISABLED``. Setting this during :ref:`can_drop_data` is recommended. .. _class_Tree_hide_folding: @@ -282,6 +282,10 @@ Returns the rectangle for custom popups. Helper to create custom cell controls t - :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const +If :ref:`drop_mode_flags` includes ``DROP_MODE_INBETWEEN``, returns -1 if ``position`` is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if :ref:`drop_mode_flags` includes ``DROP_MODE_ON_ITEM``. + +Otherwise, returns 0. If there are no tree item at ``position``, returns -100. + .. _class_Tree_get_edited: - :ref:`TreeItem` **get_edited** **(** **)** const diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 950f10f62..920417526 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -370,7 +370,7 @@ Moves this TreeItem to the top in the :ref:`Tree` hierarchy. - void **remove_child** **(** :ref:`Object` child **)** -Removes the child TreeItem at index ``index``. +Removes the given child TreeItem. .. _class_TreeItem_select: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 7403db8c4..0acf98c1a 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -207,7 +207,7 @@ Animates ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``du - :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** -Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. +Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Setting the initial value to ``null`` uses the current value of the property. Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 4d4cc1540..1a56ade0f 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -42,9 +42,9 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_version` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redo` **(** **)** | +| :ref:`bool` | :ref:`redo` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`undo` **(** **)** | +| :ref:`bool` | :ref:`undo` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enums @@ -135,10 +135,10 @@ This is useful mostly to check if something changed from a saved version. .. _class_UndoRedo_redo: -- void **redo** **(** **)** +- :ref:`bool` **redo** **(** **)** .. _class_UndoRedo_undo: -- void **undo** **(** **)** +- :ref:`bool` **undo** **(** **)** diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst new file mode 100644 index 000000000..b1b800df4 --- /dev/null +++ b/classes/class_upnp.rst @@ -0,0 +1,184 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the UPNP.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_UPNP: + +UPNP +==== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +UPNP network functions. + +Member Functions +---------------- + ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_device` **(** :ref:`UPNPDevice` device **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_devices` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`discover` **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UPNPDevice` | :ref:`get_device` **(** :ref:`int` index **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_device_count` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UPNPDevice` | :ref:`get_gateway` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`query_external_address` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_device` **(** :ref:`int` index **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_device` **(** :ref:`int` index, :ref:`UPNPDevice` device **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_UPNP_discover_ipv6: + +- :ref:`bool` **discover_ipv6** - If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. + + .. _class_UPNP_discover_local_port: + +- :ref:`int` **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. + + .. _class_UPNP_discover_multicast_if: + +- :ref:`String` **discover_multicast_if** - Multicast interface to use for discovery. Uses the default multicast interface if empty. + + +Enums +----- + + .. _enum_UPNP_UPNPResult: + +enum **UPNPResult** + +- **UPNP_RESULT_SUCCESS** = **0** --- UPNP command or discovery was successful. +- **UPNP_RESULT_NOT_AUTHORIZED** = **1** --- Not authorized to use the command on the :ref:`UPNPDevice`. May be returned when the user disabled UPNP on their router. +- **UPNP_RESULT_PORT_MAPPING_NOT_FOUND** = **2** --- No port mapping was found for the given port, protocol combination on the given :ref:`UPNPDevice`. +- **UPNP_RESULT_INCONSISTENT_PARAMETERS** = **3** --- Inconsistent parameters. +- **UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY** = **4** --- No such entry in array. May be returned if a given port, protocol combination is not found on an :ref:`UPNPDevice`. +- **UPNP_RESULT_ACTION_FAILED** = **5** --- The action failed. +- **UPNP_RESULT_SRC_IP_WILDCARD_NOT_PERMITTED** = **6** --- The :ref:`UPNPDevice` does not allow wildcard values for the source IP address. +- **UPNP_RESULT_EXT_PORT_WILDCARD_NOT_PERMITTED** = **7** --- The :ref:`UPNPDevice` does not allow wildcard values for the external port. +- **UPNP_RESULT_INT_PORT_WILDCARD_NOT_PERMITTED** = **8** --- The :ref:`UPNPDevice` does not allow wildcard values for the internal port. +- **UPNP_RESULT_REMOTE_HOST_MUST_BE_WILDCARD** = **9** --- The remote host value must be a wildcard. +- **UPNP_RESULT_EXT_PORT_MUST_BE_WILDCARD** = **10** --- The external port value must be a wildcard. +- **UPNP_RESULT_NO_PORT_MAPS_AVAILABLE** = **11** --- No port maps are available. May also be returned if port mapping functionality is not available. +- **UPNP_RESULT_CONFLICT_WITH_OTHER_MECHANISM** = **12** --- Conflict with other mechanism. May be returned instead of ``UPNP_RESULT_CONFLICT_WITH_OTHER_MAPPING`` if a port mapping conflicts with an existing one. +- **UPNP_RESULT_CONFLICT_WITH_OTHER_MAPPING** = **13** --- Conflict with an existing port mapping. +- **UPNP_RESULT_SAME_PORT_VALUES_REQUIRED** = **14** --- External and internal port values must be the same. +- **UPNP_RESULT_ONLY_PERMANENT_LEASE_SUPPORTED** = **15** --- Only permanent leases are supported. Do not use the ``duration`` parameter when adding port mappings. +- **UPNP_RESULT_INVALID_GATEWAY** = **16** --- Invalid gateway. +- **UPNP_RESULT_INVALID_PORT** = **17** --- Invalid port. +- **UPNP_RESULT_INVALID_PROTOCOL** = **18** --- Invalid protocol. +- **UPNP_RESULT_INVALID_DURATION** = **19** --- Invalid duration. +- **UPNP_RESULT_INVALID_ARGS** = **20** --- Invalid arguments. +- **UPNP_RESULT_INVALID_RESPONSE** = **21** --- Invalid response. +- **UPNP_RESULT_INVALID_PARAM** = **22** --- Invalid parameter. +- **UPNP_RESULT_HTTP_ERROR** = **23** --- HTTP error. +- **UPNP_RESULT_SOCKET_ERROR** = **24** --- Socket error. +- **UPNP_RESULT_MEM_ALLOC_ERROR** = **25** --- Error allocating memory. +- **UPNP_RESULT_NO_GATEWAY** = **26** --- No gateway available. You may need to call :ref:`discover` first, or discovery didn't detect any valid IGDs (InternetGatewayDevices). +- **UPNP_RESULT_NO_DEVICES** = **27** --- No devices available. You may need to call :ref:`discover` first, or discovery didn't detect any valid :ref:`UPNPDevice`\ s. +- **UPNP_RESULT_UNKNOWN_ERROR** = **28** --- Unknown error. + + +Description +----------- + +Provides UPNP functionality to discover :ref:`UPNPDevice`\ s on the local network and execute commands on them, like managing port mappings (port forwarding) and querying the local and remote network IP address. Note that methods on this class are synchronous and block the calling thread. + +Member Function Description +--------------------------- + +.. _class_UPNP_add_device: + +- void **add_device** **(** :ref:`UPNPDevice` device **)** + +Adds the given :ref:`UPNPDevice` to the list of discovered devices. + +.. _class_UPNP_add_port_mapping: + +- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const + +Adds a mapping to forward the external ``port`` (between 1 and 65535) on the default gateway (see :ref:`get_gateway`) to the ``internal_port`` on the local machine for the given protocol ``proto`` (either ``TCP`` or ``UDP``, with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with :ref:`get_gateway` and call :ref:`add_port_mapping` on it, if any. + +If ``internal_port`` is ``0`` (the default), the same port number is used for both the external and the internal port (the ``port`` value). + +The description (``desc``) is shown in some router UIs and can be used to point out which application added the mapping, and the lifetime of the mapping can be limited by ``duration``. However, some routers are incompatible with one or both of these, so use with caution and add fallback logic in case of errors to retry without them if in doubt. + +See :ref:`UPNPResult` for possible return values. + +.. _class_UPNP_clear_devices: + +- void **clear_devices** **(** **)** + +Clears the list of discovered devices. + +.. _class_UPNP_delete_port_mapping: + +- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const + +Deletes the port mapping for the given port and protocol combination on the default gateway (see :ref:`get_gateway`) if one exists. ``port`` must be a valid port between 1 and 65535, ``proto`` can be either ``TCP`` or ``UDP``. See :ref:`UPNPResult` for possible return values. + +.. _class_UPNP_discover: + +- :ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** + +Discovers local :ref:`UPNPDevice`\ s. Clears the list of previously discovered devices. + +Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. ``timeout`` is the time to wait for responses in miliseconds. ``ttl`` is the time-to-live; only touch this if you know what you're doing. + +See :ref:`UPNPResult` for possible return values. + +.. _class_UPNP_get_device: + +- :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** const + +Returns the :ref:`UPNPDevice` at the given ``index``. + +.. _class_UPNP_get_device_count: + +- :ref:`int` **get_device_count** **(** **)** const + +Returns the number of discovered :ref:`UPNPDevice`\ s. + +.. _class_UPNP_get_gateway: + +- :ref:`UPNPDevice` **get_gateway** **(** **)** const + +Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). + +.. _class_UPNP_query_external_address: + +- :ref:`String` **query_external_address** **(** **)** const + +Returns the external :ref:`IP` address of the default gateway (see :ref:`get_gateway`) as string. Returns an empty string on error. + +.. _class_UPNP_remove_device: + +- void **remove_device** **(** :ref:`int` index **)** + +Removes the device at ``index`` from the list of discovered devices. + +.. _class_UPNP_set_device: + +- void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** + +Sets the device at ``index`` from the list of discovered devices to ``device``. + + diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst new file mode 100644 index 000000000..437b9f9b9 --- /dev/null +++ b/classes/class_upnpdevice.rst @@ -0,0 +1,111 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the UPNPDevice.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_UPNPDevice: + +UPNPDevice +========== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +UPNP device. + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_gateway` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`query_external_address` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_UPNPDevice_description_url: + +- :ref:`String` **description_url** - URL to the device description. + + .. _class_UPNPDevice_igd_control_url: + +- :ref:`String` **igd_control_url** - IDG control URL. + + .. _class_UPNPDevice_igd_our_addr: + +- :ref:`String` **igd_our_addr** - Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. + + .. _class_UPNPDevice_igd_service_type: + +- :ref:`String` **igd_service_type** - IGD service type. + + .. _class_UPNPDevice_igd_status: + +- :ref:`IGDStatus` **igd_status** - IGD status. See :ref:`IGDStatus`. + + .. _class_UPNPDevice_service_type: + +- :ref:`String` **service_type** - Service type. + + +Enums +----- + + .. _enum_UPNPDevice_IGDStatus: + +enum **IGDStatus** + +- **IGD_STATUS_OK** = **0** --- OK. +- **IGD_STATUS_HTTP_ERROR** = **1** --- HTTP error. +- **IGD_STATUS_HTTP_EMPTY** = **2** --- Empty HTTP response. +- **IGD_STATUS_NO_URLS** = **3** --- Returned response contained no URLs. +- **IGD_STATUS_NO_IGD** = **4** --- Not a valid IGD. +- **IGD_STATUS_DISCONNECTED** = **5** --- Disconnected. +- **IGD_STATUS_UNKNOWN_DEVICE** = **6** --- Unknown device. +- **IGD_STATUS_INVALID_CONTROL** = **7** --- Invalid control. +- **IGD_STATUS_MALLOC_ERROR** = **8** --- Memory allocation error. +- **IGD_STATUS_UNKNOWN_ERROR** = **9** --- Unknown error. + + +Description +----------- + +UPNP device. See :ref:`UPNP` for UPNP discovery and utility functions. Provides low-level access to UPNP control commands. Allows to manage port mappings (port forwarding) and to query network information of the device (like local and external IP address and status). Note that methods on this class are synchronous and block the calling thread. + +Member Function Description +--------------------------- + +.. _class_UPNPDevice_add_port_mapping: + +- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const + +Adds a port mapping to forward the given external port on this :ref:`UPNPDevice` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. + +.. _class_UPNPDevice_delete_port_mapping: + +- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const + +Deletes the port mapping identified by the given port and protocol combination on this device. See :ref:`UPNP.delete_port_mapping`. + +.. _class_UPNPDevice_is_valid_gateway: + +- :ref:`bool` **is_valid_gateway** **(** **)** const + +Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. + +.. _class_UPNPDevice_query_external_address: + +- :ref:`String` **query_external_address** **(** **)** const + +Returns the external IP address of this :ref:`UPNPDevice` or an empty string. + + diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 47427d831..f1c24f28e 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -58,6 +58,8 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`normalized` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`project` **(** :ref:`Vector2` b **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` phi **)** | @@ -85,11 +87,26 @@ Member Variables - :ref:`float` **y** - The vector's y component. +Numeric Constants +----------------- + +- **ZERO** = **Vector2( 0, 0 )** +- **INF** = **Vector2( inf, inf )** +- **LEFT** = **Vector2( -1, 0 )** +- **RIGHT** = **Vector2( 1, 0 )** +- **UP** = **Vector2( 0, -1 )** +- **DOWN** = **Vector2( 0, 1 )** + Description ----------- 2-element structure that can be used to represent positions in 2d space or any other pair of numeric values. +Tutorials +--------- + +- :doc:`../tutorials/math/index` + Member Function Description --------------------------- @@ -141,6 +158,8 @@ Returns the vector "bounced off" from a plane defined by the given normal. - :ref:`Vector2` **ceil** **(** **)** +Returns the vector with all components rounded up. + .. _class_Vector2_clamped: - :ref:`Vector2` **clamped** **(** :ref:`float` length **)** @@ -181,7 +200,7 @@ Returns the dot product with vector ``b``. - :ref:`Vector2` **floor** **(** **)** -Remove the fractional part of x and y. +Returns the vector with all components rounded down. .. _class_Vector2_is_normalized: @@ -213,6 +232,12 @@ Returns the result of the linear interpolation between this vector and ``b`` by Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. +.. _class_Vector2_project: + +- :ref:`Vector2` **project** **(** :ref:`Vector2` b **)** + +Returns the vector projected onto the vector ``b``. + .. _class_Vector2_reflect: - :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** @@ -229,6 +254,8 @@ Returns the vector rotated by ``phi`` radians. - :ref:`Vector2` **round** **(** **)** +Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. + .. _class_Vector2_slerp: - :ref:`Vector2` **slerp** **(** :ref:`Vector2` b, :ref:`float` t **)** diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 12a2a4112..4e73d222e 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -58,6 +58,8 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` b **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` b **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | @@ -95,12 +97,25 @@ Numeric Constants - **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis` and :ref:`min_axis`. - **AXIS_Y** = **1** --- Enumerated value for the Y axis. - **AXIS_Z** = **2** --- Enumerated value for the Z axis. +- **ZERO** = **Vector3( 0, 0, 0 )** +- **INF** = **Vector3( inf, inf, inf )** +- **LEFT** = **Vector3( -1, 0, 0 )** +- **RIGHT** = **Vector3( 1, 0, 0 )** +- **UP** = **Vector3( 0, 1, 0 )** +- **DOWN** = **Vector3( 0, -1, 0 )** +- **FORWARD** = **Vector3( 0, 0, -1 )** +- **BACK** = **Vector3( 0, 0, 1 )** Description ----------- Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. +Tutorials +--------- + +- :doc:`../tutorials/math/index` + Member Function Description --------------------------- @@ -224,6 +239,12 @@ Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. Returns the outer product with ``b``. +.. _class_Vector3_project: + +- :ref:`Vector3` **project** **(** :ref:`Vector3` b **)** + +Returns the vector projected onto the vector ``b``. + .. _class_Vector3_reflect: - :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** @@ -240,6 +261,8 @@ Rotates the vector around a given axis by ``phi`` radians. The axis must be a no - :ref:`Vector3` **round** **(** **)** +Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. + .. _class_Vector3_slerp: - :ref:`Vector3` **slerp** **(** :ref:`Vector3` b, :ref:`float` t **)** diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 792abbf3e..9a3e16ced 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -193,7 +193,7 @@ Enums enum **UpdateMode** - **UPDATE_DISABLED** = **0** --- Do not update the render target. -- **UPDATE_ONCE** = **1** --- Update the render target once, then switch to ``UPDATE_DISABLED`` +- **UPDATE_ONCE** = **1** --- Update the render target once, then switch to ``UPDATE_DISABLED``. - **UPDATE_WHEN_VISIBLE** = **2** --- Update the render target only when it is visible. This is the default value. - **UPDATE_ALWAYS** = **3** --- Always update the render target. @@ -223,9 +223,9 @@ enum **MSAA** enum **ClearMode** -- **CLEAR_MODE_ALWAYS** = **0** -- **CLEAR_MODE_NEVER** = **1** -- **CLEAR_MODE_ONLY_NEXT_FRAME** = **2** +- **CLEAR_MODE_ALWAYS** = **0** --- Always clear the render target before drawing. +- **CLEAR_MODE_NEVER** = **1** --- Never clear the render target. +- **CLEAR_MODE_ONLY_NEXT_FRAME** = **2** --- Clear the render target next frame, then switch to ``CLEAR_MODE_NEVER``. .. _enum_Viewport_Usage: @@ -242,7 +242,7 @@ enum **DebugDraw** - **DEBUG_DRAW_DISABLED** = **0** --- Objects are displayed normally. - **DEBUG_DRAW_UNSHADED** = **1** --- Objects are displayed without light information. -- **DEBUG_DRAW_OVERDRAW** = **2** +- **DEBUG_DRAW_OVERDRAW** = **2** --- Objected are displayed semi-transparent with additive blending so you can see where they intersect. - **DEBUG_DRAW_WIREFRAME** = **3** --- Objects are displayed in wireframe style. .. _enum_Viewport_ShadowAtlasQuadrantSubdiv: @@ -266,7 +266,7 @@ A Viewport creates a different view into the screen, or a sub-view inside anothe Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports. -If a viewport is a child of a :ref:`Control`, it will automatically take up its same rect and position, otherwise they must be set manually. +If a viewport is a child of a :ref:`ViewportContainer`, it will automatically take up its size, otherwise it must be set manually. Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. @@ -274,6 +274,12 @@ Also, viewports can be assigned to different screens in case the devices have mu Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw. +Tutorials +--------- + +- :doc:`../tutorials/2d/2d_transforms` +- :doc:`../tutorials/viewports/index` + Member Function Description --------------------------- @@ -281,61 +287,61 @@ Member Function Description - :ref:`World` **find_world** **(** **)** const -Return the 3D world of the viewport, or if no such present, the one of the parent viewport. +Returns the 3D world of the viewport, or if none the world of the parent viewport. .. _class_Viewport_find_world_2d: - :ref:`World2D` **find_world_2d** **(** **)** const -Return the 2D world of the viewport. +Returns the 2D world of the viewport. .. _class_Viewport_get_camera: - :ref:`Camera` **get_camera** **(** **)** const -Return the active 3D camera. +Returns the active 3D camera. .. _class_Viewport_get_final_transform: - :ref:`Transform2D` **get_final_transform** **(** **)** const -Get the total transform of the viewport. +Returns the total transform of the viewport. .. _class_Viewport_get_mouse_position: - :ref:`Vector2` **get_mouse_position** **(** **)** const -Get the mouse position, relative to the viewport. +Returns the mouse position relative to the viewport. .. _class_Viewport_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** -Get the specific information about the viewport from rendering pipeline. +Returns information about the viewport from the rendering pipeline. .. _class_Viewport_get_size_override: - :ref:`Vector2` **get_size_override** **(** **)** const -Get the size override set with :ref:`set_size_override`. +Returns the size override set with :ref:`set_size_override`. .. _class_Viewport_get_texture: - :ref:`ViewportTexture` **get_texture** **(** **)** const -Get the viewport's texture, for use with various objects that you want to texture with the viewport. +Returns the viewport's texture. .. _class_Viewport_get_viewport_rid: - :ref:`RID` **get_viewport_rid** **(** **)** const -Get the viewport RID from the :ref:`VisualServer`. +Returns the viewport's RID from the :ref:`VisualServer`. .. _class_Viewport_get_visible_rect: - :ref:`Rect2` **get_visible_rect** **(** **)** const -Return the final, visible rect in global screen coordinates. +Returns the visible rectangle in global screen coordinates. .. _class_Viewport_gui_get_drag_data: @@ -347,7 +353,7 @@ Returns the drag data from the GUI, that was previously returned by :ref:`Contro - :ref:`bool` **gui_has_modal_stack** **(** **)** const -Returns whether there are shown modals on-screen. +Returns ``true`` if there are visible modals on-screen. .. _class_Viewport_input: @@ -357,13 +363,13 @@ Returns whether there are shown modals on-screen. - :ref:`bool` **is_size_override_enabled** **(** **)** const -Get the enabled status of the size override set with :ref:`set_size_override`. +Returns ``true`` if the size override is enabled. See :ref:`set_size_override`. .. _class_Viewport_is_size_override_stretch_enabled: - :ref:`bool` **is_size_override_stretch_enabled** **(** **)** const -Get the enabled status of the size stretch override set with :ref:`set_size_override_stretch`. +Returns ``true`` if the size stretch override is enabled. See :ref:`set_size_override_stretch`. .. _class_Viewport_set_attach_to_screen_rect: @@ -373,13 +379,13 @@ Get the enabled status of the size stretch override set with :ref:`set_size_over - void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** -Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to ``(-1, -1)``, it won't update the size. +Sets the size override of the viewport. If the ``enable`` parameter is ``true`` the override is used, otherwise it uses the default size. If the size parameter is ``(-1, -1)``, it won't update the size. .. _class_Viewport_set_size_override_stretch: - void **set_size_override_stretch** **(** :ref:`bool` enabled **)** -Set whether the size override affects stretch as well. +If ``true`` the size override affects stretch as well. .. _class_Viewport_unhandled_input: @@ -389,12 +395,12 @@ Set whether the size override affects stretch as well. - void **update_worlds** **(** **)** -Force update of the 2D and 3D worlds. +Forces update of the 2D and 3D worlds. .. _class_Viewport_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** -Warp the mouse to a position, relative to the viewport. +Warps the mouse to a position relative to the viewport. diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 9f4b828bf..42368392c 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -14,13 +14,20 @@ ViewportTexture Brief Description ----------------- - +Texture which displays the content of a :ref:`Viewport`. Member Variables ---------------- .. _class_ViewportTexture_viewport_path: -- :ref:`NodePath` **viewport_path** +- :ref:`NodePath` **viewport_path** - The path to the :ref:`Viewport` node to display. This is relative to the scene root, not to the node which uses the texture. +Description +----------- + +Displays the content of a :ref:`Viewport` node as a dynamic :ref:`Texture`. This can be used to mix controls, 2D, and 3D elements in the same scene. + +To create a ViewportTexture in code, use the :ref:`Viewport.get_texture` method on the target viewport. + diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 6655134cf..6352d74ee 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -9,7 +9,7 @@ VisualInstance **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BakedLightmap`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`CSGShape`, :ref:`GIProbe`, :ref:`GeometryInstance` +**Inherited By:** :ref:`BakedLightmap`, :ref:`Light`, :ref:`RootMotionView`, :ref:`ReflectionProbe`, :ref:`CSGShape`, :ref:`GIProbe`, :ref:`GeometryInstance` **Category:** Core @@ -21,13 +21,17 @@ Brief Description Member Functions ---------------- -+--------------------------+------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------+ -| void | :ref:`set_base` **(** :ref:`RID` base **)** | -+--------------------------+------------------------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` layer **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base` **(** :ref:`RID` base **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_mask_bit` **(** :ref:`int` layer, :ref:`bool` enabled **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -48,6 +52,10 @@ Member Function Description Returns the :ref:`AABB` (also known as the bounding box) for this VisualInstance. +.. _class_VisualInstance_get_layer_mask_bit: + +- :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** const + .. _class_VisualInstance_get_transformed_aabb: - :ref:`AABB` **get_transformed_aabb** **(** **)** const @@ -64,4 +72,8 @@ Sets the base of the VisualInstance, which changes how the engine handles the Vi It is recommended to only use set_base if you know what you're doing. +.. _class_VisualInstance_set_layer_mask_bit: + +- void **set_layer_mask_bit** **(** :ref:`int` layer, :ref:`bool` enabled **)** + diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 312f82bd7..180358edf 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -124,6 +124,11 @@ A script implemented in the Visual Script programming environment. The script e You are most likely to use this class via the Visual Script editor or when writing plugins for it. +Tutorials +--------- + +- :doc:`../getting_started/scripting/visual_script/index` + Member Function Description --------------------------- diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index c901ab0d8..019fe916e 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -9,7 +9,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` +**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptYield`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` **Category:** Core diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 0fceb6e7d..825300660 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -19,706 +19,726 @@ Server for anything visible. Member Functions ---------------- -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`directional_light_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`bool` swap_buffers=true **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`environment_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_dof_blur_far` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_dof_blur_near` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`finish` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_sync` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_cube` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_texture` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_white_texture` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`gi_probe_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_bias` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`gi_probe_get_bounds` **(** :ref:`RID` probe **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_cell_size` **(** :ref:`RID` probe **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gi_probe_get_dynamic_range` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_energy` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_normal_bias` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_propagation` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`gi_probe_get_to_cell_xform` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gi_probe_is_compressed` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gi_probe_is_interior` **(** :ref:`RID` arg0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_bias` **(** :ref:`RID` bias, :ref:`float` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_bounds` **(** :ref:`RID` probe, :ref:`AABB` bounds **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_cell_size` **(** :ref:`RID` probe, :ref:`float` range **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_compress` **(** :ref:`RID` enable, :ref:`bool` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_dynamic_data` **(** :ref:`RID` data, :ref:`PoolIntArray` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_dynamic_range` **(** :ref:`RID` range, :ref:`int` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_energy` **(** :ref:`RID` energy, :ref:`float` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_interior` **(** :ref:`RID` enable, :ref:`bool` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_normal_bias` **(** :ref:`RID` bias, :ref:`float` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_propagation` **(** :ref:`RID` propagation, :ref:`float` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` xform, :ref:`Transform` arg1 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_changed` **(** **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_begin` **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`init` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_as_instance_lod` **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_draw_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_detail` **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97792 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_remove_surface` **(** :ref:`RID` mesh, :ref:`int` index **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`omni_light_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`particles_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_allocate` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`skeleton_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`sky_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`spot_light_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sync` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`CubeMapSide` cube_side=0 **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`CubeMapSide` cube_side=0 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data_partial` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`CubeMapSide` cube_side=0 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`textures_keep_original` **(** :ref:`bool` enable **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_create` **(** **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_layer` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`camera_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`directional_light_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`environment_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_dof_blur_far` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_dof_blur_near` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`finish` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_sync` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_cube` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_texture` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_white_texture` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`gi_probe_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_bias` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`gi_probe_get_bounds` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_cell_size` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gi_probe_get_dynamic_range` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_energy` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_normal_bias` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_propagation` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`gi_probe_get_to_cell_xform` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gi_probe_is_compressed` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gi_probe_is_interior` **(** :ref:`RID` probe **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_bounds` **(** :ref:`RID` probe, :ref:`AABB` bounds **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_cell_size` **(** :ref:`RID` probe, :ref:`float` range **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_compress` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_dynamic_data` **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_dynamic_range` **(** :ref:`RID` probe, :ref:`int` range **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_normal_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_propagation` **(** :ref:`RID` probe, :ref:`float` propagation **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` probe, :ref:`Transform` xform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_changed` **(** **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_begin` **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`immediate_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`init` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_as_instance_lod` **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_draw_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_omni_set_shadow_detail` **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`material_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_remove_surface` **(** :ref:`RID` mesh, :ref:`int` index **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_stride` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PrimitiveType` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_update_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_as_bulk_array` **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`omni_light_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`particles_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`scenario_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_allocate` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`skeleton_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`sky_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`spot_light_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sync` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_depth` **(** :ref:`RID` texture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Format` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TextureType` | :ref:`texture_get_type` **(** :ref:`RID` texture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_data_partial` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`textures_keep_original` **(** :ref:`bool` enable **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_create` **(** **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_layer` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_VisualServer_frame_drawn_in_thread: +.. _class_VisualServer_frame_post_draw: -- **frame_drawn_in_thread** **(** **)** +- **frame_post_draw** **(** **)** + +.. _class_VisualServer_frame_pre_draw: + +- **frame_pre_draw** **(** **)** Numeric Constants @@ -759,6 +779,15 @@ enum **CubeMapSide** - **CUBEMAP_FRONT** = **4** --- Marks the front side of a cubemap. - **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap. + .. _enum_VisualServer_TextureType: + +enum **TextureType** + +- **TEXTURE_TYPE_2D** = **0** +- **TEXTURE_TYPE_CUBEMAP** = **1** +- **TEXTURE_TYPE_2D_ARRAY** = **2** +- **TEXTURE_TYPE_3D** = **3** + .. _enum_VisualServer_LightType: enum **LightType** @@ -767,18 +796,20 @@ enum **LightType** - **LIGHT_OMNI** = **1** --- is an omni light. - **LIGHT_SPOT** = **2** --- is an spot light. - .. _enum_VisualServer_PrimitiveType: + .. _enum_VisualServer_ArrayType: -enum **PrimitiveType** +enum **ArrayType** -- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points. -- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines. -- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end. -- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex). -- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles. -- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle). -- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle). -- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally. +- **ARRAY_VERTEX** = **0** --- Array is a vertex array. +- **ARRAY_NORMAL** = **1** --- Array is a normal array. +- **ARRAY_TANGENT** = **2** --- Array is a tangent array. +- **ARRAY_COLOR** = **3** --- Array is a color array. +- **ARRAY_TEX_UV** = **4** --- Array is a uv coordinates array. +- **ARRAY_TEX_UV2** = **5** --- Array is a uv coordinates array for the second uv coordinates. +- **ARRAY_BONES** = **6** --- Array contains bone information. +- **ARRAY_WEIGHTS** = **7** --- Array is weight information. +- **ARRAY_INDEX** = **8** --- Array is index array. +- **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally. .. _enum_VisualServer_BlendShapeMode: @@ -949,12 +980,26 @@ enum **EnvironmentDOFBlurQuality** - **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1** - **ENV_DOF_BLUR_QUALITY_HIGH** = **2** + .. _enum_VisualServer_PrimitiveType: + +enum **PrimitiveType** + +- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points. +- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines. +- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end. +- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex). +- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles. +- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle). +- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle). +- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally. + .. _enum_VisualServer_InstanceFlags: enum **InstanceFlags** - **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** -- **INSTANCE_FLAG_MAX** = **1** +- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1** +- **INSTANCE_FLAG_MAX** = **2** .. _enum_VisualServer_ViewportClearMode: @@ -971,21 +1016,6 @@ enum **LightOmniShadowDetail** - **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** - **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** - .. _enum_VisualServer_ArrayType: - -enum **ArrayType** - -- **ARRAY_VERTEX** = **0** --- Array is a vertex array. -- **ARRAY_NORMAL** = **1** --- Array is a normal array. -- **ARRAY_TANGENT** = **2** --- Array is a tangent array. -- **ARRAY_COLOR** = **3** --- Array is a color array. -- **ARRAY_TEX_UV** = **4** --- Array is a uv coordinates array. -- **ARRAY_TEX_UV2** = **5** --- Array is a uv coordinates array for the second uv coordinates. -- **ARRAY_BONES** = **6** --- Array contains bone information. -- **ARRAY_WEIGHTS** = **7** --- Array is weight information. -- **ARRAY_INDEX** = **8** --- Array is index array. -- **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally. - .. _enum_VisualServer_CanvasLightMode: enum **CanvasLightMode** @@ -1043,7 +1073,7 @@ enum **ArrayFormat** - **ARRAY_COMPRESS_INDEX** = **131072** - **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices. - **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit. -- **ARRAY_COMPRESS_DEFAULT** = **97792** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. +- **ARRAY_COMPRESS_DEFAULT** = **97280** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. .. _enum_VisualServer_EnvironmentSSAOBlur: @@ -1118,8 +1148,7 @@ enum **TextureFlags** More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. - **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space. - **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeat texture with alternate sections mirrored. -- **TEXTURE_FLAG_CUBEMAP** = **2048** --- Texture is a cubemap. -- **TEXTURE_FLAG_USED_FOR_STREAMING** = **4096** --- Texture is a video surface. +- **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface. - **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. .. _enum_VisualServer_EnvironmentToneMapper: @@ -1588,9 +1617,7 @@ Modulates all colors in the given canvas. .. _class_VisualServer_draw: -- void **draw** **(** :ref:`bool` swap_buffers=true **)** - -Draws a frame. +- void **draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** .. _class_VisualServer_environment_create: @@ -1654,7 +1681,7 @@ Draws a frame. .. _class_VisualServer_environment_set_ssao: -- void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** +- void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** .. _class_VisualServer_environment_set_ssr: @@ -1672,9 +1699,7 @@ Removes buffers and clears testcubes. .. _class_VisualServer_force_draw: -- void **force_draw** **(** :ref:`bool` swap_buffers=true **)** - -Draws a frame. Same as :ref:`draw`. +- void **force_draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** .. _class_VisualServer_force_sync: @@ -1718,7 +1743,7 @@ Returns the id of a white texture. Creates one if none exists. .. _class_VisualServer_gi_probe_get_bias: -- :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` arg0 **)** const +- :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_bounds: @@ -1730,39 +1755,39 @@ Returns the id of a white texture. Creates one if none exists. .. _class_VisualServer_gi_probe_get_dynamic_data: -- :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` arg0 **)** const +- :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_dynamic_range: -- :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` arg0 **)** const +- :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_energy: -- :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` arg0 **)** const +- :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_normal_bias: -- :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` arg0 **)** const +- :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_propagation: -- :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` arg0 **)** const +- :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_to_cell_xform: -- :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` arg0 **)** const +- :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_is_compressed: -- :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` arg0 **)** const +- :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_is_interior: -- :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` arg0 **)** const +- :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_set_bias: -- void **gi_probe_set_bias** **(** :ref:`RID` bias, :ref:`float` arg1 **)** +- void **gi_probe_set_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** .. _class_VisualServer_gi_probe_set_bounds: @@ -1774,35 +1799,35 @@ Returns the id of a white texture. Creates one if none exists. .. _class_VisualServer_gi_probe_set_compress: -- void **gi_probe_set_compress** **(** :ref:`RID` enable, :ref:`bool` arg1 **)** +- void **gi_probe_set_compress** **(** :ref:`RID` probe, :ref:`bool` enable **)** .. _class_VisualServer_gi_probe_set_dynamic_data: -- void **gi_probe_set_dynamic_data** **(** :ref:`RID` data, :ref:`PoolIntArray` arg1 **)** +- void **gi_probe_set_dynamic_data** **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** .. _class_VisualServer_gi_probe_set_dynamic_range: -- void **gi_probe_set_dynamic_range** **(** :ref:`RID` range, :ref:`int` arg1 **)** +- void **gi_probe_set_dynamic_range** **(** :ref:`RID` probe, :ref:`int` range **)** .. _class_VisualServer_gi_probe_set_energy: -- void **gi_probe_set_energy** **(** :ref:`RID` energy, :ref:`float` arg1 **)** +- void **gi_probe_set_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** .. _class_VisualServer_gi_probe_set_interior: -- void **gi_probe_set_interior** **(** :ref:`RID` enable, :ref:`bool` arg1 **)** +- void **gi_probe_set_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** .. _class_VisualServer_gi_probe_set_normal_bias: -- void **gi_probe_set_normal_bias** **(** :ref:`RID` bias, :ref:`float` arg1 **)** +- void **gi_probe_set_normal_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** .. _class_VisualServer_gi_probe_set_propagation: -- void **gi_probe_set_propagation** **(** :ref:`RID` propagation, :ref:`float` arg1 **)** +- void **gi_probe_set_propagation** **(** :ref:`RID` probe, :ref:`float` propagation **)** .. _class_VisualServer_gi_probe_set_to_cell_xform: -- void **gi_probe_set_to_cell_xform** **(** :ref:`RID` xform, :ref:`Transform` arg1 **)** +- void **gi_probe_set_to_cell_xform** **(** :ref:`RID` probe, :ref:`Transform` xform **)** .. _class_VisualServer_has_changed: @@ -2122,7 +2147,7 @@ Sets a shader material's shader. .. _class_VisualServer_mesh_add_surface_from_arrays: -- void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97792 **)** +- void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE\_\* constants for types. @@ -2228,6 +2253,14 @@ Returns a mesh's surface's arrays for blend shapes Returns the format of a mesh's surface. +.. _class_VisualServer_mesh_surface_get_format_offset: + +- :ref:`int` **mesh_surface_get_format_offset** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const + +.. _class_VisualServer_mesh_surface_get_format_stride: + +- :ref:`int` **mesh_surface_get_format_stride** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const + .. _class_VisualServer_mesh_surface_get_index_array: - :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const @@ -2258,9 +2291,13 @@ Returns the aabb of a mesh's surface's skeleton. Sets a mesh's surface's material. +.. _class_VisualServer_mesh_surface_update_region: + +- void **mesh_surface_update_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** + .. _class_VisualServer_multimesh_allocate: -- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format **)** +- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** .. _class_VisualServer_multimesh_get_aabb: @@ -2282,6 +2319,10 @@ Sets a mesh's surface's material. - :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +.. _class_VisualServer_multimesh_instance_get_custom_data: + +- :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** const + .. _class_VisualServer_multimesh_instance_get_transform: - :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** const @@ -2294,6 +2335,10 @@ Sets a mesh's surface's material. - void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** +.. _class_VisualServer_multimesh_instance_set_custom_data: + +- void **multimesh_instance_set_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** + .. _class_VisualServer_multimesh_instance_set_transform: - void **multimesh_instance_set_transform** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** @@ -2302,6 +2347,10 @@ Sets a mesh's surface's material. - void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** +.. _class_VisualServer_multimesh_set_as_bulk_array: + +- void **multimesh_set_as_bulk_array** **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** + .. _class_VisualServer_multimesh_set_mesh: - void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** @@ -2578,9 +2627,7 @@ Sets a sky's texture. .. _class_VisualServer_texture_allocate: -- void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** - -Allocates space for a texture's image or video. +- void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** .. _class_VisualServer_texture_create: @@ -2602,10 +2649,14 @@ Returns a list of all the textures and their information. .. _class_VisualServer_texture_get_data: -- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`CubeMapSide` cube_side=0 **)** const +- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the :ref:`RID` of the image at one of the cubes sides. +.. _class_VisualServer_texture_get_depth: + +- :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const + .. _class_VisualServer_texture_get_flags: - :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const @@ -2636,6 +2687,10 @@ Returns the texture's path. Returns the opengl id of the texture's image. +.. _class_VisualServer_texture_get_type: + +- :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const + .. _class_VisualServer_texture_get_width: - :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const @@ -2644,13 +2699,13 @@ Returns the texture's width. .. _class_VisualServer_texture_set_data: -- void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`CubeMapSide` cube_side=0 **)** +- void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. .. _class_VisualServer_texture_set_data_partial: -- void **texture_set_data_partial** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`CubeMapSide` cube_side=0 **)** +- void **texture_set_data_partial** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** .. _class_VisualServer_texture_set_flags: @@ -2672,9 +2727,7 @@ If ``true``, sets internal processes to shrink all image data to half the size. .. _class_VisualServer_texture_set_size_override: -- void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** - -Overwrites the texture's width and height. +- void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** .. _class_VisualServer_textures_keep_original: diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst new file mode 100644 index 000000000..cb8c5c8c4 --- /dev/null +++ b/classes/class_visualshader.rst @@ -0,0 +1,132 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShader: + +VisualShader +============ + +**Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VisualShaderNode` | :ref:`get_node` **(** :ref:`Type` type, :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_connections` **(** :ref:`Type` type **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_node_list` **(** :ref:`Type` type **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`Type` type, :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_valid_node_id` **(** :ref:`Type` type **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_connection` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`Type` type, :ref:`int` id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + + .. _class_VisualShader_graph_offset: + +- :ref:`Vector2` **graph_offset** + + +Numeric Constants +----------------- + +- **NODE_ID_INVALID** = **-1** +- **NODE_ID_OUTPUT** = **0** + +Enums +----- + + .. _enum_VisualShader_Type: + +enum **Type** + +- **TYPE_VERTEX** = **0** +- **TYPE_FRAGMENT** = **1** +- **TYPE_LIGHT** = **2** +- **TYPE_MAX** = **3** + + +Member Function Description +--------------------------- + +.. _class_VisualShader_add_node: + +- void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** + +.. _class_VisualShader_can_connect_nodes: + +- :ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const + +.. _class_VisualShader_connect_nodes: + +- :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** + +.. _class_VisualShader_disconnect_nodes: + +- void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** + +.. _class_VisualShader_get_node: + +- :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const + +.. _class_VisualShader_get_node_connections: + +- :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const + +.. _class_VisualShader_get_node_list: + +- :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const + +.. _class_VisualShader_get_node_position: + +- :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const + +.. _class_VisualShader_get_valid_node_id: + +- :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** const + +.. _class_VisualShader_is_node_connection: + +- :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const + +.. _class_VisualShader_remove_node: + +- void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** + +.. _class_VisualShader_set_mode: + +- void **set_mode** **(** :ref:`Mode` mode **)** + +.. _class_VisualShader_set_node_position: + +- void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** + + diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst new file mode 100644 index 000000000..35fa45d37 --- /dev/null +++ b/classes/class_visualshadernode.rst @@ -0,0 +1,61 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNode.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNode: + +VisualShaderNode +================ + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeColorConstant` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_port_default_value` **(** :ref:`int` port, :ref:`Variant` value **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_VisualShaderNode_editor_refresh_request: + +- **editor_refresh_request** **(** **)** + + +Member Variables +---------------- + + .. _class_VisualShaderNode_default_input_values: + +- :ref:`Array` **default_input_values** + + .. _class_VisualShaderNode_output_port_for_preview: + +- :ref:`int` **output_port_for_preview** + + +Member Function Description +--------------------------- + +.. _class_VisualShaderNode_get_input_port_default_value: + +- :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** const + +.. _class_VisualShaderNode_set_input_port_default_value: + +- void **set_input_port_default_value** **(** :ref:`int` port, :ref:`Variant` value **)** + + diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst new file mode 100644 index 000000000..00e511934 --- /dev/null +++ b/classes/class_visualshadernodecolorconstant.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeColorConstant: + +VisualShaderNodeColorConstant +============================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeColorConstant_constant: + +- :ref:`Color` **constant** + + diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst new file mode 100644 index 000000000..cb25f0f76 --- /dev/null +++ b/classes/class_visualshadernodecolorop.rst @@ -0,0 +1,44 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorOp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeColorOp: + +VisualShaderNodeColorOp +======================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeColorOp_operator: + +- :ref:`Operator` **operator** + + +Enums +----- + + .. _enum_VisualShaderNodeColorOp_Operator: + +enum **Operator** + +- **OP_SCREEN** = **0** +- **OP_DIFFERENCE** = **1** +- **OP_DARKEN** = **2** +- **OP_LIGHTEN** = **3** +- **OP_OVERLAY** = **4** +- **OP_DODGE** = **5** +- **OP_BURN** = **6** +- **OP_SOFT_LIGHT** = **7** +- **OP_HARD_LIGHT** = **8** + + diff --git a/classes/class_visualshadernodecoloruniform.rst b/classes/class_visualshadernodecoloruniform.rst new file mode 100644 index 000000000..3413c334d --- /dev/null +++ b/classes/class_visualshadernodecoloruniform.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeColorUniform: + +VisualShaderNodeColorUniform +============================ + +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst new file mode 100644 index 000000000..2ef34bce7 --- /dev/null +++ b/classes/class_visualshadernodecubemap.rst @@ -0,0 +1,42 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubeMap.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeCubeMap: + +VisualShaderNodeCubeMap +======================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeCubeMap_cube_map: + +- :ref:`CubeMap` **cube_map** + + .. _class_VisualShaderNodeCubeMap_texture_type: + +- :ref:`TextureType` **texture_type** + + +Enums +----- + + .. _enum_VisualShaderNodeCubeMap_TextureType: + +enum **TextureType** + +- **TYPE_DATA** = **0** +- **TYPE_COLOR** = **1** +- **TYPE_NORMALMAP** = **2** + + diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapuniform.rst new file mode 100644 index 000000000..5945d233a --- /dev/null +++ b/classes/class_visualshadernodecubemapuniform.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubeMapUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeCubeMapUniform: + +VisualShaderNodeCubeMapUniform +============================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst new file mode 100644 index 000000000..8aaf5930e --- /dev/null +++ b/classes/class_visualshadernodedotproduct.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeDotProduct.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeDotProduct: + +VisualShaderNodeDotProduct +========================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst new file mode 100644 index 000000000..86d7f61c6 --- /dev/null +++ b/classes/class_visualshadernodeinput.rst @@ -0,0 +1,34 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeInput.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeInput: + +VisualShaderNodeInput +===================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Signals +------- + +.. _class_VisualShaderNodeInput_input_type_changed: + +- **input_type_changed** **(** **)** + + +Member Variables +---------------- + + .. _class_VisualShaderNodeInput_input_name: + +- :ref:`String` **input_name** + + diff --git a/classes/class_visualshadernodeoutput.rst b/classes/class_visualshadernodeoutput.rst new file mode 100644 index 000000000..6e06fe0ce --- /dev/null +++ b/classes/class_visualshadernodeoutput.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeOutput.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeOutput: + +VisualShaderNodeOutput +====================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst new file mode 100644 index 000000000..b64561d1a --- /dev/null +++ b/classes/class_visualshadernodescalarconstant.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarConstant: + +VisualShaderNodeScalarConstant +============================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeScalarConstant_constant: + +- :ref:`float` **constant** + + diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst new file mode 100644 index 000000000..99c435b0b --- /dev/null +++ b/classes/class_visualshadernodescalarfunc.rst @@ -0,0 +1,55 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarFunc: + +VisualShaderNodeScalarFunc +========================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeScalarFunc_function: + +- :ref:`Function` **function** + + +Enums +----- + + .. _enum_VisualShaderNodeScalarFunc_Function: + +enum **Function** + +- **FUNC_SIN** = **0** +- **FUNC_COS** = **1** +- **FUNC_TAN** = **2** +- **FUNC_ASIN** = **3** +- **FUNC_ACOS** = **4** +- **FUNC_ATAN** = **5** +- **FUNC_SINH** = **6** +- **FUNC_COSH** = **7** +- **FUNC_TANH** = **8** +- **FUNC_LOG** = **9** +- **FUNC_EXP** = **10** +- **FUNC_SQRT** = **11** +- **FUNC_ABS** = **12** +- **FUNC_SIGN** = **13** +- **FUNC_FLOOR** = **14** +- **FUNC_ROUND** = **15** +- **FUNC_CEIL** = **16** +- **FUNC_FRAC** = **17** +- **FUNC_SATURATE** = **18** +- **FUNC_NEGATE** = **19** + + diff --git a/classes/class_visualshadernodescalarinterp.rst b/classes/class_visualshadernodescalarinterp.rst new file mode 100644 index 000000000..4c8e912dd --- /dev/null +++ b/classes/class_visualshadernodescalarinterp.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarInterp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarInterp: + +VisualShaderNodeScalarInterp +============================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst new file mode 100644 index 000000000..bd40f4a0f --- /dev/null +++ b/classes/class_visualshadernodescalarop.rst @@ -0,0 +1,44 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarOp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarOp: + +VisualShaderNodeScalarOp +======================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeScalarOp_operator: + +- :ref:`Operator` **operator** + + +Enums +----- + + .. _enum_VisualShaderNodeScalarOp_Operator: + +enum **Operator** + +- **OP_ADD** = **0** +- **OP_SUB** = **1** +- **OP_MUL** = **2** +- **OP_DIV** = **3** +- **OP_MOD** = **4** +- **OP_POW** = **5** +- **OP_MAX** = **6** +- **OP_MIN** = **7** +- **OP_ATAN2** = **8** + + diff --git a/classes/class_visualshadernodescalaruniform.rst b/classes/class_visualshadernodescalaruniform.rst new file mode 100644 index 000000000..990978bbd --- /dev/null +++ b/classes/class_visualshadernodescalaruniform.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarUniform: + +VisualShaderNodeScalarUniform +============================= + +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst new file mode 100644 index 000000000..95597c437 --- /dev/null +++ b/classes/class_visualshadernodetexture.rst @@ -0,0 +1,55 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTexture: + +VisualShaderNodeTexture +======================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeTexture_source: + +- :ref:`Source` **source** + + .. _class_VisualShaderNodeTexture_texture: + +- :ref:`Texture` **texture** + + .. _class_VisualShaderNodeTexture_texture_type: + +- :ref:`TextureType` **texture_type** + + +Enums +----- + + .. _enum_VisualShaderNodeTexture_Source: + +enum **Source** + +- **SOURCE_TEXTURE** = **0** +- **SOURCE_SCREEN** = **1** +- **SOURCE_2D_TEXTURE** = **2** +- **SOURCE_2D_NORMAL** = **3** + + .. _enum_VisualShaderNodeTexture_TextureType: + +enum **TextureType** + +- **TYPE_DATA** = **0** +- **TYPE_COLOR** = **1** +- **TYPE_NORMALMAP** = **2** + + diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst new file mode 100644 index 000000000..6da480507 --- /dev/null +++ b/classes/class_visualshadernodetextureuniform.rst @@ -0,0 +1,50 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTextureUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTextureUniform: + +VisualShaderNodeTextureUniform +============================== + +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeTextureUniform_color_default: + +- :ref:`ColorDefault` **color_default** + + .. _class_VisualShaderNodeTextureUniform_texture_type: + +- :ref:`TextureType` **texture_type** + + +Enums +----- + + .. _enum_VisualShaderNodeTextureUniform_TextureType: + +enum **TextureType** + +- **TYPE_DATA** = **0** +- **TYPE_COLOR** = **1** +- **TYPE_NORMALMAP** = **2** +- **TYPE_ANISO** = **3** + + .. _enum_VisualShaderNodeTextureUniform_ColorDefault: + +enum **ColorDefault** + +- **COLOR_DEFAULT_WHITE** = **0** +- **COLOR_DEFAULT_BLACK** = **1** + + diff --git a/classes/class_visualshadernodetransformcompose.rst b/classes/class_visualshadernodetransformcompose.rst new file mode 100644 index 000000000..006ec5007 --- /dev/null +++ b/classes/class_visualshadernodetransformcompose.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformCompose.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTransformCompose: + +VisualShaderNodeTransformCompose +================================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst new file mode 100644 index 000000000..1ea37f21f --- /dev/null +++ b/classes/class_visualshadernodetransformconstant.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTransformConstant: + +VisualShaderNodeTransformConstant +================================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeTransformConstant_constant: + +- :ref:`Transform` **constant** + + diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst new file mode 100644 index 000000000..8365b69c2 --- /dev/null +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformDecompose.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTransformDecompose: + +VisualShaderNodeTransformDecompose +================================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst new file mode 100644 index 000000000..81c1876c7 --- /dev/null +++ b/classes/class_visualshadernodetransformmult.rst @@ -0,0 +1,37 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformMult.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTransformMult: + +VisualShaderNodeTransformMult +============================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeTransformMult_operator: + +- :ref:`Operator` **operator** + + +Enums +----- + + .. _enum_VisualShaderNodeTransformMult_Operator: + +enum **Operator** + +- **OP_AxB** = **0** +- **OP_BxA** = **1** + + diff --git a/classes/class_visualshadernodetransformuniform.rst b/classes/class_visualshadernodetransformuniform.rst new file mode 100644 index 000000000..bd4e4bbd2 --- /dev/null +++ b/classes/class_visualshadernodetransformuniform.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTransformUniform: + +VisualShaderNodeTransformUniform +================================ + +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst new file mode 100644 index 000000000..2dec4b9a1 --- /dev/null +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -0,0 +1,39 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformVecMult.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTransformVecMult: + +VisualShaderNodeTransformVecMult +================================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeTransformVecMult_operator: + +- :ref:`Operator` **operator** + + +Enums +----- + + .. _enum_VisualShaderNodeTransformVecMult_Operator: + +enum **Operator** + +- **OP_AxB** = **0** +- **OP_BxA** = **1** +- **OP_3x3_AxB** = **2** +- **OP_3x3_BxA** = **3** + + diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst new file mode 100644 index 000000000..44911bc63 --- /dev/null +++ b/classes/class_visualshadernodeuniform.rst @@ -0,0 +1,28 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeUniform: + +VisualShaderNodeUniform +======================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`VisualShaderNodeVec3Uniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeColorUniform` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeUniform_uniform_name: + +- :ref:`String` **uniform_name** + + diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst new file mode 100644 index 000000000..7d79e3268 --- /dev/null +++ b/classes/class_visualshadernodevec3constant.rst @@ -0,0 +1,26 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVec3Constant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVec3Constant: + +VisualShaderNodeVec3Constant +============================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeVec3Constant_constant: + +- :ref:`Vector3` **constant** + + diff --git a/classes/class_visualshadernodevec3uniform.rst b/classes/class_visualshadernodevec3uniform.rst new file mode 100644 index 000000000..9c1484007 --- /dev/null +++ b/classes/class_visualshadernodevec3uniform.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVec3Uniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVec3Uniform: + +VisualShaderNodeVec3Uniform +=========================== + +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst new file mode 100644 index 000000000..b72cee4dd --- /dev/null +++ b/classes/class_visualshadernodevectorcompose.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorCompose.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorCompose: + +VisualShaderNodeVectorCompose +============================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectordecompose.rst b/classes/class_visualshadernodevectordecompose.rst new file mode 100644 index 000000000..869eb96de --- /dev/null +++ b/classes/class_visualshadernodevectordecompose.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorDecompose.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorDecompose: + +VisualShaderNodeVectorDecompose +=============================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst new file mode 100644 index 000000000..56dd5bd5d --- /dev/null +++ b/classes/class_visualshadernodevectorfunc.rst @@ -0,0 +1,41 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorFunc: + +VisualShaderNodeVectorFunc +========================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeVectorFunc_function: + +- :ref:`Function` **function** + + +Enums +----- + + .. _enum_VisualShaderNodeVectorFunc_Function: + +enum **Function** + +- **FUNC_NORMALIZE** = **0** +- **FUNC_SATURATE** = **1** +- **FUNC_NEGATE** = **2** +- **FUNC_RECIPROCAL** = **3** +- **FUNC_RGB2HSV** = **4** +- **FUNC_HSV2RGB** = **5** + + diff --git a/classes/class_visualshadernodevectorinterp.rst b/classes/class_visualshadernodevectorinterp.rst new file mode 100644 index 000000000..16b6b3e2f --- /dev/null +++ b/classes/class_visualshadernodevectorinterp.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorInterp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorInterp: + +VisualShaderNodeVectorInterp +============================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorlen.rst b/classes/class_visualshadernodevectorlen.rst new file mode 100644 index 000000000..c25291bf6 --- /dev/null +++ b/classes/class_visualshadernodevectorlen.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorLen.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorLen: + +VisualShaderNodeVectorLen +========================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst new file mode 100644 index 000000000..6ddebf4b9 --- /dev/null +++ b/classes/class_visualshadernodevectorop.rst @@ -0,0 +1,44 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorOp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorOp: + +VisualShaderNodeVectorOp +======================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Variables +---------------- + + .. _class_VisualShaderNodeVectorOp_operator: + +- :ref:`Operator` **operator** + + +Enums +----- + + .. _enum_VisualShaderNodeVectorOp_Operator: + +enum **Operator** + +- **OP_ADD** = **0** +- **OP_SUB** = **1** +- **OP_MUL** = **2** +- **OP_DIV** = **3** +- **OP_MOD** = **4** +- **OP_POW** = **5** +- **OP_MAX** = **6** +- **OP_MIN** = **7** +- **OP_CROSS** = **8** + + diff --git a/classes/class_world.rst b/classes/class_world.rst index c2757c912..aeed6c422 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -45,3 +45,8 @@ Description Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world. +Tutorials +--------- + +- :doc:`../tutorials/physics/ray-casting` + diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 2a01fec1f..16eeea929 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -37,3 +37,8 @@ Description Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world. +Tutorials +--------- + +- :doc:`../tutorials/physics/ray-casting` + diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index fc1089a46..2a7308f9b 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -33,3 +33,8 @@ The parameters defined in the ``WorldEnvironment`` can be overridden by an :ref: The ``WorldEnvironment`` allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene. +Tutorials +--------- + +- :doc:`../tutorials/3d/environment_and_post_processing` +