diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 56e60da7d8e..98833dc5d12 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -23,6 +23,10 @@ Singletons are also documented here, since they can be accessed from anywhere. For the entries related to GDScript which can be accessed in any script see :ref:`@GDScript`. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 9898bce3228..a8b724131d1 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -25,6 +25,10 @@ Negative values for :ref:`size` are not supported and \ **Note:** Unlike :ref:`Rect2`, **AABB** does not have a variant that uses integer coordinates. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index a925fdb152d..47d014cfbeb 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -19,7 +19,7 @@ Blends two of three animations additively inside of an :ref:`AnimationNodeBlendT Description ----------- -A resource to add to an :ref:`AnimationNodeBlendTree`. Blends two animations out of three additively out of three based on the amounmt value. +A resource to add to an :ref:`AnimationNodeBlendTree`. Blends two animations out of three additively out of three based on the amount value. This animation node has three inputs: diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 918df1c3652..67782a4afed 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -19,7 +19,7 @@ Blends two of three animations linearly inside of an :ref:`AnimationNodeBlendTre Description ----------- -A resource to add to an :ref:`AnimationNodeBlendTree`. Blends two animations out of three linearly out of three based on the amounmt value. +A resource to add to an :ref:`AnimationNodeBlendTree`. Blends two animations out of three linearly out of three based on the amount value. This animation node has three inputs: diff --git a/classes/class_array.rst b/classes/class_array.rst index a149653ccde..368509ac033 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -68,6 +68,10 @@ Arrays can be concatenated using the ``+`` operator: \ **Note:** Erasing elements while iterating over arrays is **not** supported and will result in unpredictable behavior. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 0135cf79f9d..c52a92a93d6 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -115,7 +115,7 @@ Property Descriptions - void **set_loop** **(** :ref:`bool` value **)** - :ref:`bool` **has_loop** **(** **)** -If ``true``, the stream will automatically loop when it reaches the end. +If ``true``, the audio will play again from the specified :ref:`loop_offset` once it is done playing. Useful for ambient sounds and background music. .. rst-class:: classref-item-separator diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 701b2cc1d67..475dffb2518 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -25,6 +25,10 @@ Basis can also be accessed as an array of 3D vectors. These vectors are usually For more information, read the "Matrices and transforms" documentation article. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_boneattachment3d.rst b/classes/class_boneattachment3d.rst index 4103c8fcb86..5e1b43e35bc 100644 --- a/classes/class_boneattachment3d.rst +++ b/classes/class_boneattachment3d.rst @@ -176,7 +176,7 @@ Sets the :ref:`NodePath` to the external skeleton that the BoneA void **set_use_external_skeleton** **(** :ref:`bool` use_external_skeleton **)** -Sets whether the BoneAttachment3D node will use an extenral :ref:`Skeleton3D` node rather than attenpting to use its parent node as the :ref:`Skeleton3D`. When set to ``true``, the BoneAttachment3D node will use the external :ref:`Skeleton3D` node set in :ref:`set_external_skeleton`. +Sets whether the BoneAttachment3D node will use an external :ref:`Skeleton3D` node rather than attempting to use its parent node as the :ref:`Skeleton3D`. When set to ``true``, the BoneAttachment3D node will use the external :ref:`Skeleton3D` node set in :ref:`set_external_skeleton`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_callable.rst b/classes/class_callable.rst index 01e96d41622..7be19b5c9c3 100644 --- a/classes/class_callable.rst +++ b/classes/class_callable.rst @@ -81,6 +81,10 @@ In GDScript, it's possible to create lambda functions within a method. Lambda fu # This will work, as lambdas are custom callables. create_tween().tween_callback(func(): my_dictionary.clear()) +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_camera3d.rst b/classes/class_camera3d.rst index 3d4834ee0f7..dff858d2604 100644 --- a/classes/class_camera3d.rst +++ b/classes/class_camera3d.rst @@ -79,6 +79,8 @@ Methods +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`get_camera_projection` **(** **)** |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_camera_rid` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_camera_transform` **(** **)** |const| | @@ -497,6 +499,18 @@ If this is the current camera, remove it from being current. If ``enable_next`` ---- +.. _class_Camera3D_method_get_camera_projection: + +.. rst-class:: classref-method + +:ref:`Projection` **get_camera_projection** **(** **)** |const| + +Returns the projection matrix that this camera uses to render to its associated viewport. The camera must be part of the scene tree to function. + +.. rst-class:: classref-item-separator + +---- + .. _class_Camera3D_method_get_camera_rid: .. rst-class:: classref-method diff --git a/classes/class_color.rst b/classes/class_color.rst index d65b4bc3921..a8b30a0fa77 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -25,6 +25,10 @@ Colors can be created in various ways: By the various **Color** constructors, by \ `Color constants cheatsheet `__ +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 3a9c12f5aa4..415f3779234 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -206,6 +206,23 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_CPUParticles2D_signal_finished: + +.. rst-class:: classref-signal + +**finished** **(** **)** + +Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Enumerations ------------ diff --git a/classes/class_cpuparticles3d.rst b/classes/class_cpuparticles3d.rst index 37abe02e3eb..0aec26bbf70 100644 --- a/classes/class_cpuparticles3d.rst +++ b/classes/class_cpuparticles3d.rst @@ -215,6 +215,23 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_CPUParticles3D_signal_finished: + +.. rst-class:: classref-signal + +**finished** **(** **)** + +Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Enumerations ------------ diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 4dcdf6ea3c6..75bf7da415a 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -189,6 +189,10 @@ The keys of a dictionary can be iterated with the ``for`` keyword: \ **Note:** Erasing elements while iterating over dictionaries is **not** supported and will result in unpredictable behavior. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 67f838da5b0..e3241fbd925 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -54,6 +54,8 @@ Methods +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`enable_for_stealing_focus` **(** :ref:`int` process_id **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`file_dialog_show` **(** :ref:`String` title, :ref:`String` current_directory, :ref:`String` filename, :ref:`bool` show_hidden, :ref:`FileDialogMode` mode, :ref:`PackedStringArray` filters, :ref:`Callable` callback **)** | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_process_and_drop_events` **(** **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_accent_color` **(** **)** |const| | @@ -182,6 +184,8 @@ Methods +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical` **(** :ref:`Key` keycode **)** |const| | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`keyboard_get_label_from_physical` **(** :ref:`Key` keycode **)** |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`keyboard_get_layout_count` **(** **)** |const| | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`keyboard_get_layout_language` **(** :ref:`int` index **)** |const| | @@ -886,6 +890,56 @@ Represents the size of the :ref:`CursorShape` en ---- +.. _enum_DisplayServer_FileDialogMode: + +.. rst-class:: classref-enumeration + +enum **FileDialogMode**: + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_FILE** = ``0`` + +The native file dialog allows selecting one, and only one file. + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_FILES** = ``1`` + +The native file dialog allows selecting multiple files. + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_DIR** = ``2`` + +The native file dialog only allows selecting a directory, disallowing the selection of any file. + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_ANY** = ``3`` + +The native file dialog allows selecting one file or directory. + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_SAVE_FILE** = ``4`` + +The native file dialog will warn when a file exists. + +.. rst-class:: classref-item-separator + +---- + .. _enum_DisplayServer_WindowMode: .. rst-class:: classref-enumeration @@ -1482,6 +1536,28 @@ Allows the ``process_id`` PID to steal focus from this window. In other words, t ---- +.. _class_DisplayServer_method_file_dialog_show: + +.. rst-class:: classref-method + +:ref:`Error` **file_dialog_show** **(** :ref:`String` title, :ref:`String` current_directory, :ref:`String` filename, :ref:`bool` show_hidden, :ref:`FileDialogMode` mode, :ref:`PackedStringArray` filters, :ref:`Callable` callback **)** + +Displays OS native dialog for selecting files or directories in the file system. + +Callbacks have the following arguments: ``bool status, PackedStringArray selected_paths``. + +\ **Note:** This method is implemented if the display server has the ``FEATURE_NATIVE_DIALOG`` feature. + +\ **Note:** This method is implemented on macOS. + +\ **Note:** On macOS, native file dialogs have no title. + +\ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions` to get a list of saved bookmarks. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_force_process_and_drop_events: .. rst-class:: classref-method @@ -2509,6 +2585,20 @@ Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout ---- +.. _class_DisplayServer_method_keyboard_get_label_from_physical: + +.. rst-class:: classref-method + +:ref:`Key` **keyboard_get_label_from_physical** **(** :ref:`Key` keycode **)** |const| + +Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout. + +\ **Note:** This method is implemented on Linux (X11), macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_keyboard_get_layout_count: .. rst-class:: classref-method diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index 65dd29c0b75..bd712c8b0a3 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -88,6 +88,10 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`package/retain_data_on_uninstall` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`package/show_as_launcher_app` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`package/show_in_android_tv` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`package/signed` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`package/unique_name` | @@ -776,6 +780,30 @@ If ``true``, when the user uninstalls an app, a prompt to keep the app's data wi ---- +.. _class_EditorExportPlatformAndroid_property_package/show_as_launcher_app: + +.. rst-class:: classref-property + +:ref:`bool` **package/show_as_launcher_app** + +If ``true``, the user will be able to set this app as the system launcher in Android preferences. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorExportPlatformAndroid_property_package/show_in_android_tv: + +.. rst-class:: classref-property + +:ref:`bool` **package/show_in_android_tv** + +If ``true``, this app will show in Android TV launcher UI. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformAndroid_property_package/signed: .. rst-class:: classref-property diff --git a/classes/class_editorexportplatformmacos.rst b/classes/class_editorexportplatformmacos.rst index 051502f5768..bde5b0fc636 100644 --- a/classes/class_editorexportplatformmacos.rst +++ b/classes/class_editorexportplatformmacos.rst @@ -86,6 +86,8 @@ Properties +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`codesign/entitlements/app_sandbox/files_pictures` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`codesign/entitlements/app_sandbox/files_user_selected` | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`codesign/entitlements/app_sandbox/helper_executables` | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`codesign/entitlements/app_sandbox/network_client` | @@ -552,6 +554,18 @@ Allows read or write access to the user's "Pictures" folder. See `com.apple.secu ---- +.. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/files_user_selected: + +.. rst-class:: classref-property + +:ref:`int` **codesign/entitlements/app_sandbox/files_user_selected** + +Allows read or write access to the locations the user has selected using a native file dialog. See `com.apple.security.files.user-selected.read-write `__. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformMacOS_property_codesign/entitlements/app_sandbox/helper_executables: .. rst-class:: classref-property diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 77d4d60e3e0..0e9b4429fb9 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -290,7 +290,9 @@ Return ``true``, if the result of :ref:`_get_export_options` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** -Adds a custom file to be exported. ``path`` is the virtual path that can be used to load the file, ``file`` is the binary data of the file. If ``remap`` is ``true``, file will not be exported, but instead remapped to the given ``path``. +Adds a custom file to be exported. ``path`` is the virtual path that can be used to load the file, ``file`` is the binary data of the file. + +When called inside :ref:`_export_file` and ``remap`` is ``true``, the current file will not be exported, but instead remapped to this custom file. ``remap`` is ignored when called in other places. .. rst-class:: classref-item-separator diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index cc9c199e83c..813bb703d03 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -103,6 +103,8 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/2d/smart_snapping_line_color` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/2d/use_integer_zoom_by_default` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/2d/viewport_border_color` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/3d/default_fov` | @@ -457,6 +459,8 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`text_editor/completion/code_complete_delay` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/code_complete_enabled` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/completion/complete_file_paths` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`text_editor/completion/idle_parse_delay` | @@ -907,6 +911,18 @@ The color to use when drawing smart snapping lines in the 2D editor. The smart s ---- +.. _class_EditorSettings_property_editors/2d/use_integer_zoom_by_default: + +.. rst-class:: classref-property + +:ref:`bool` **editors/2d/use_integer_zoom_by_default** + +If ``true``, the 2D editor will snap to integer zoom values while not holding the :kbd:`Alt` key and powers of two while holding it. If ``false``, this behavior is swapped. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/2d/viewport_border_color: .. rst-class:: classref-property @@ -3143,6 +3159,18 @@ The delay in seconds after which autocompletion suggestions should be displayed ---- +.. _class_EditorSettings_property_text_editor/completion/code_complete_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/completion/code_complete_enabled** + +If ``true``, code completion will be triggered automatically after :ref:`text_editor/completion/code_complete_delay`. If ``false``, you can still trigger completion manually by pressing :kbd:`Ctrl + Space` (:kbd:`Cmd + Space` on macOS). + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/completion/complete_file_paths: .. rst-class:: classref-property diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 6052a3b06d5..b57e709fb8a 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -243,7 +243,7 @@ Method Descriptions :ref:`String` **get_architecture_name** **(** **)** |const| -Returns the name of the CPU architecture the Godot binary was built for. Possible return values are ``x86_64``, ``x86_32``, ``arm64``, ``armv7``, ``rv64``, ``riscv``, ``ppc64``, ``ppc``, ``wasm64`` and ``wasm32``. +Returns the name of the CPU architecture the Godot binary was built for. Possible return values are ``x86_64``, ``x86_32``, ``arm64``, ``arm32``, ``rv64``, ``riscv``, ``ppc64``, ``ppc``, ``wasm64`` and ``wasm32``. To detect whether the current CPU architecture is 64-bit, you can use the fact that all 64-bit architecture names have ``64`` in their name: @@ -253,16 +253,16 @@ To detect whether the current CPU architecture is 64-bit, you can use the fact t .. code-tab:: gdscript if "64" in Engine.get_architecture_name(): - print("Running on 64-bit CPU.") + print("Running a 64-bit build of Godot.") else: - print("Running on 32-bit CPU.") + print("Running a 32-bit build of Godot.") .. code-tab:: csharp if (Engine.GetArchitectureName().Contains("64")) - GD.Print("Running on 64-bit CPU."); + GD.Print("Running a 64-bit build of Godot."); else - GD.Print("Running on 32-bit CPU."); + GD.Print("Running a 32-bit build of Godot."); diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 3c4427bc4f1..22831cdb831 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -52,6 +52,8 @@ Properties +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | title | ``"Save a File"`` (overrides :ref:`Window`) | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_native_dialog` | ``false`` | + +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -395,6 +397,25 @@ If non-empty, the given sub-folder will be "root" of this **FileDialog**, i.e. u If ``true``, the dialog will show hidden files. +.. rst-class:: classref-item-separator + +---- + +.. _class_FileDialog_property_use_native_dialog: + +.. rst-class:: classref-property + +:ref:`bool` **use_native_dialog** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_use_native_dialog** **(** :ref:`bool` value **)** +- :ref:`bool` **get_use_native_dialog** **(** **)** + +If ``true``, :ref:`access` is set to :ref:`ACCESS_FILESYSTEM`, and it is supported by the current :ref:`DisplayServer`, OS native dialog will be used instead of custom one. + +\ **Note:** On macOS, sandboxed apps always use native dialogs to access host filesystem. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index 25c98fb0188..354e4b03238 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -112,6 +112,25 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_GPUParticles2D_signal_finished: + +.. rst-class:: classref-signal + +**finished** **(** **)** + +Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. + +\ **Note:** Due to the particles being computed on the GPU there might be a delay before the signal gets emitted. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Enumerations ------------ @@ -595,6 +614,8 @@ Method Descriptions Returns a rectangle containing the positions of all existing particles. +\ **Note:** When using threaded rendering this method synchronizes the rendering thread. Calling it often may have a negative impact on performance. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 2c81809e851..35f87b533cd 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -120,6 +120,25 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_GPUParticles3D_signal_finished: + +.. rst-class:: classref-signal + +**finished** **(** **)** + +Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. + +\ **Note:** Due to the particles being computed on the GPU there might be a delay before the signal gets emitted. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Enumerations ------------ diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 4e53cc06ead..13ce4017a48 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -164,6 +164,8 @@ Property Descriptions Gradient's colors returned as a :ref:`PackedColorArray`. +\ **Note:** This property returns a copy, modifying the return value does not update the gradient. To update the gradient use :ref:`set_color` method (for updating colors individually) or assign to this property directly (for bulk-updating all colors at once). + .. rst-class:: classref-item-separator ---- @@ -217,6 +219,8 @@ The algorithm used to interpolate between points of the gradient. See :ref:`Inte Gradient's offsets returned as a :ref:`PackedFloat32Array`. +\ **Note:** This property returns a copy, modifying the return value does not update the gradient. To update the gradient use :ref:`set_offset` method (for updating offsets individually) or assign to this property directly (for bulk-updating all offsets at once). + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_image.rst b/classes/class_image.rst index fdf08ff56a2..711a07392b7 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -139,6 +139,10 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_png_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_svg_from_buffer` **(** :ref:`PackedByteArray` buffer, :ref:`float` scale=1.0 **)** | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_svg_from_string` **(** :ref:`String` svg_str, :ref:`float` scale=1.0 **)** | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_tga_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | @@ -1398,6 +1402,36 @@ Loads an image from the binary contents of a PNG file. ---- +.. _class_Image_method_load_svg_from_buffer: + +.. rst-class:: classref-method + +:ref:`Error` **load_svg_from_buffer** **(** :ref:`PackedByteArray` buffer, :ref:`float` scale=1.0 **)** + +Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (**.svg**). + +\ **Note:** Beware when using compressed SVG files (like **.svgz**), they need to be ``decompressed`` before loading. + +\ **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the ``module_svg_enabled=no`` SCons option. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Image_method_load_svg_from_string: + +.. rst-class:: classref-method + +:ref:`Error` **load_svg_from_string** **(** :ref:`String` svg_str, :ref:`float` scale=1.0 **)** + +Loads an image from the string contents of a SVG file (**.svg**). + +\ **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the ``module_svg_enabled=no`` SCons option. + +.. rst-class:: classref-item-separator + +---- + .. _class_Image_method_load_tga_from_buffer: .. rst-class:: classref-method diff --git a/classes/class_input.rst b/classes/class_input.rst index 0944eaeeb0f..53d522058f6 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -135,6 +135,8 @@ Methods +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_magnetometer` **(** :ref:`Vector3` value **)** | +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`should_ignore_device` **(** :ref:`int` vendor_id, :ref:`int` product_id **)** |const| | + +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | @@ -979,6 +981,20 @@ Sets the value of the magnetic field of the magnetometer sensor. Can be used for ---- +.. _class_Input_method_should_ignore_device: + +.. rst-class:: classref-method + +:ref:`bool` **should_ignore_device** **(** :ref:`int` vendor_id, :ref:`int` product_id **)** |const| + +Queries whether an input device should be ignored or not. Devices can be ignored by setting the environment variable ``SDL_GAMECONTROLLER_IGNORE_DEVICES``. Read the `SDL documentation `__ for more information. + +\ **Note:** Some 3rd party tools can contribute to the list of ignored devices. For example, *SteamInput* creates virtual devices from physical devices for remapping purposes. To avoid handling the same input device twice, the original device is added to the ignore list. + +.. rst-class:: classref-item-separator + +---- + .. _class_Input_method_start_joy_vibration: .. rst-class:: classref-method diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index f80ba8ffef6..3c115a0bc17 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -407,7 +407,7 @@ The maximum distance the detail mesh surface should deviate from heightfield, in - void **set_edge_max_error** **(** :ref:`float` value **)** - :ref:`float` **get_edge_max_error** **(** **)** -The maximum distance a simplfied contour's border edges should deviate the original raw contour. +The maximum distance a simplified contour's border edges should deviate the original raw contour. .. rst-class:: classref-item-separator diff --git a/classes/class_navigationmeshgenerator.rst b/classes/class_navigationmeshgenerator.rst index 6eb247e2e4a..78966926def 100644 --- a/classes/class_navigationmeshgenerator.rst +++ b/classes/class_navigationmeshgenerator.rst @@ -109,6 +109,8 @@ Parses the :ref:`SceneTree` for source geometry according to th \ **Note:** This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe. +\ **Performance:** While convenient, reading data arrays from :ref:`Mesh` resources can affect the frame rate negatively. The data needs to be received from the GPU, stalling the :ref:`RenderingServer` in the process. For performance prefer the use of e.g. collision shapes or creating the data arrays entirely in code. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigationregion2d.rst b/classes/class_navigationregion2d.rst index a280690b58c..07c20b39ae0 100644 --- a/classes/class_navigationregion2d.rst +++ b/classes/class_navigationregion2d.rst @@ -79,12 +79,16 @@ Methods +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_region_rid` **(** **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_avoidance_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -262,6 +266,18 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map** **(** **)** |const| + +Returns the current navigation map :ref:`RID` used by this region. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationRegion2D_method_get_region_rid: .. rst-class:: classref-method @@ -294,6 +310,18 @@ void **set_navigation_layer_value** **(** :ref:`int` layer_number, :r Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationRegion2D_method_set_navigation_map: + +.. rst-class:: classref-method + +void **set_navigation_map** **(** :ref:`RID` navigation_map **)** + +Sets the :ref:`RID` of the navigation map this region should use. By default the region will automatically join the :ref:`World2D` default navigation map so this function is only required to override the default map. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigationregion3d.rst b/classes/class_navigationregion3d.rst index 8e5df807558..6c2779db870 100644 --- a/classes/class_navigationregion3d.rst +++ b/classes/class_navigationregion3d.rst @@ -75,10 +75,14 @@ Methods +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_region_rid` **(** **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -249,6 +253,18 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map** **(** **)** |const| + +Returns the current navigation map :ref:`RID` used by this region. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationRegion3D_method_get_region_rid: .. rst-class:: classref-method @@ -269,6 +285,18 @@ void **set_navigation_layer_value** **(** :ref:`int` layer_number, :r Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationRegion3D_method_set_navigation_map: + +.. rst-class:: classref-method + +void **set_navigation_map** **(** :ref:`RID` navigation_map **)** + +Sets the :ref:`RID` of the navigation map this region should use. By default the region will automatically join the :ref:`World3D` default navigation map so this function is only required to override the default map. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index 3a0e42e5cc7..a37aaeb3bdb 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -1467,6 +1467,8 @@ Parses the :ref:`SceneTree` for source geometry according to th \ **Note:** This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe. +\ **Performance:** While convenient, reading data arrays from :ref:`Mesh` resources can affect the frame rate negatively. The data needs to be received from the GPU, stalling the :ref:`RenderingServer` in the process. For performance prefer the use of e.g. collision shapes or creating the data arrays entirely in code. + .. rst-class:: classref-item-separator ---- @@ -1491,6 +1493,8 @@ void **region_bake_navigation_mesh** **(** :ref:`NavigationMesh` resource. Use this resource with :ref:`parse_source_geometry_data` to parse the SceneTree for nodes that should contribute to the navigation mesh baking. The SceneTree parsing needs to happen on the main thread. After the parsing is finished use the resource with :ref:`bake_from_source_geometry_data` to bake a navigation mesh. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_node.rst b/classes/class_node.rst index dae755129cf..20ddcd3e5d7 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1067,9 +1067,9 @@ The name of the node. This name is unique among the siblings (other child nodes - void **set_owner** **(** :ref:`Node` value **)** - :ref:`Node` **get_owner** **(** **)** -The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using :ref:`PackedScene`), all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree`\ s, with instancing and subinstancing. +The node owner. A node can have any ancestor node as owner (i.e. a parent, grandparent, etc. node ascending in the tree). This implies that :ref:`add_child` should be called before setting the owner, so that this relationship of parenting exists. When saving a node (using :ref:`PackedScene`), all the nodes it owns will be saved with it. This allows for the creation of complex scene trees, with instancing and subinstancing. -\ **Note:** If you want a child to be persisted to a :ref:`PackedScene`, you must set :ref:`owner` in addition to calling :ref:`add_child`. This is typically relevant for :doc:`tool scripts <../tutorials/plugins/running_code_in_the_editor>` and :doc:`editor plugins <../tutorials/plugins/editor/index>`. If :ref:`add_child` is called without setting :ref:`owner`, the newly added **Node** will not be visible in the scene tree, though it will be visible in the 2D/3D view. +\ **Note:** If you want a child to be persisted to a :ref:`PackedScene`, you must set :ref:`owner` in addition to calling :ref:`add_child`. This is typically relevant for :doc:`tool scripts <../tutorials/plugins/running_code_in_the_editor>` and :doc:`editor plugins <../tutorials/plugins/editor/index>`. If a new node is added to the tree without setting its owner as an ancestor in that tree, it will be visible in the 2D/3D view, but not in the scene tree (and not persisted when packing or saving). .. rst-class:: classref-item-separator diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index f9f3a9b2adb..81403ff52a6 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -45,6 +45,10 @@ See also :ref:`StringName`, which is a similar concept for gen \ **Note:** In a boolean context, a **NodePath** will evaluate to ``false`` if it is empty (``NodePath("")``). Otherwise, a **NodePath** will always evaluate to ``true``. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_occluderinstance3d.rst b/classes/class_occluderinstance3d.rst index 0538755b591..7d49216f05c 100644 --- a/classes/class_occluderinstance3d.rst +++ b/classes/class_occluderinstance3d.rst @@ -100,7 +100,7 @@ To improve performance and avoid artifacts, it is recommended to exclude dynamic The simplification distance to use for simplifying the generated occluder polygon (in 3D units). Higher values result in a less detailed occluder mesh, which improves performance but reduces culling accuracy. -The occluder geometry is rendered on the CPU, so it is important to keep its geometry as simple as possible. Since the buffer is rendered at a low resolution, less detailed occluder meshes generally still work well. The default value is fairly aggressive, so you may have to decrase it if you run into false negatives (objects being occluded even though they are visible by the camera). A value of ``0.01`` will act conservatively, and will keep geometry *perceptually* unaffected in the occlusion culling buffer. Depending on the scene, a value of ``0.01`` may still simplify the mesh noticeably compared to disabling simplification entirely. +The occluder geometry is rendered on the CPU, so it is important to keep its geometry as simple as possible. Since the buffer is rendered at a low resolution, less detailed occluder meshes generally still work well. The default value is fairly aggressive, so you may have to decrease it if you run into false negatives (objects being occluded even though they are visible by the camera). A value of ``0.01`` will act conservatively, and will keep geometry *perceptually* unaffected in the occlusion culling buffer. Depending on the scene, a value of ``0.01`` may still simplify the mesh noticeably compared to disabling simplification entirely. Setting this to ``0.0`` disables simplification entirely, but vertices in the exact same position will still be merged. The mesh will also be re-indexed to reduce both the number of vertices and indices. diff --git a/classes/class_os.rst b/classes/class_os.rst index 00e1b832c83..f2ec22095e6 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -149,6 +149,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_restart_on_exit_set` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_sandboxed` **(** **)** |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** |const| | @@ -165,6 +167,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`request_permissions` **(** **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`revoke_granted_permissions` **(** **)** | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_environment` **(** :ref:`String` variable, :ref:`String` value **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_restart_on_exit` **(** :ref:`bool` restart, :ref:`PackedStringArray` arguments=PackedStringArray() **)** | @@ -734,9 +738,9 @@ Returns the path to the current engine executable. :ref:`PackedStringArray` **get_granted_permissions** **(** **)** |const| -With this function, you can get the list of dangerous permissions that have been granted to the Android application. +On Android devices: With this function, you can get the list of dangerous permissions that have been granted. -\ **Note:** This method is implemented only on Android. +On macOS (sandboxed applications only): This function returns the list of user selected folders accessible to the application. Use native file dialog to request folder access permission. .. rst-class:: classref-item-separator @@ -1246,6 +1250,20 @@ Returns ``true`` if the project will automatically restart when it exits for any ---- +.. _class_OS_method_is_sandboxed: + +.. rst-class:: classref-method + +:ref:`bool` **is_sandboxed** **(** **)** |const| + +Returns ``true`` if application is running in the sandbox. + +\ **Note:** This method is implemented on macOS. + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_is_stdout_verbose: .. rst-class:: classref-method @@ -1371,6 +1389,18 @@ With this function, you can request dangerous permissions since normal permissio ---- +.. _class_OS_method_revoke_granted_permissions: + +.. rst-class:: classref-method + +void **revoke_granted_permissions** **(** **)** + +On macOS (sandboxed applications only), this function clears list of user selected folders accessible to the application. + +.. rst-class:: classref-item-separator + +---- + .. _class_OS_method_set_environment: .. rst-class:: classref-method @@ -1463,7 +1493,7 @@ If ``file_or_dir_path`` is a valid directory path, and ``open_folder`` is ``true Use :ref:`ProjectSettings.globalize_path` to convert a ``res://`` or ``user://`` path into a system path for use with this method. -\ **Note:** Currently this method is only implemented on Windows. On other platforms, it will fallback to :ref:`shell_open` with a directory path for ``file_or_dir_path``. +\ **Note:** Currently this method is only implemented on Windows and macOS. On other platforms, it will fallback to :ref:`shell_open` with a directory path of ``file_or_dir_path`` with prefix ``file://``. .. rst-class:: classref-item-separator diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst index 5266258bd9a..da789579375 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -21,6 +21,10 @@ An array specifically designed to hold bytes. Packs data tightly, so it saves me \ **PackedByteArray** also provides methods to encode/decode various types to/from bytes. The way values are encoded is an implementation detail and shouldn't be relied upon when interacting with external apps. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_packedcolorarray.rst b/classes/class_packedcolorarray.rst index 7881397151d..4f44ff7721d 100644 --- a/classes/class_packedcolorarray.rst +++ b/classes/class_packedcolorarray.rst @@ -19,6 +19,10 @@ Description An array specifically designed to hold :ref:`Color`. Packs data tightly, so it saves memory for large array sizes. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_packedfloat32array.rst b/classes/class_packedfloat32array.rst index 19907772230..6244485388e 100644 --- a/classes/class_packedfloat32array.rst +++ b/classes/class_packedfloat32array.rst @@ -21,6 +21,10 @@ An array specifically designed to hold 32-bit floating-point values (float). Pac If you need to pack 64-bit floats tightly, see :ref:`PackedFloat64Array`. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_packedfloat64array.rst b/classes/class_packedfloat64array.rst index fc84071418c..4020f7a7b14 100644 --- a/classes/class_packedfloat64array.rst +++ b/classes/class_packedfloat64array.rst @@ -21,6 +21,10 @@ An array specifically designed to hold 64-bit floating-point values (double). Pa If you only need to pack 32-bit floats tightly, see :ref:`PackedFloat32Array` for a more memory-friendly alternative. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_packedint32array.rst b/classes/class_packedint32array.rst index ff23a9469a7..e5e4dfa230e 100644 --- a/classes/class_packedint32array.rst +++ b/classes/class_packedint32array.rst @@ -21,6 +21,10 @@ An array specifically designed to hold 32-bit integer values. Packs data tightly \ **Note:** This type stores signed 32-bit integers, which means it can take values in the interval ``[-2^31, 2^31 - 1]``, i.e. ``[-2147483648, 2147483647]``. Exceeding those bounds will wrap around. In comparison, :ref:`int` uses signed 64-bit integers which can hold much larger values. If you need to pack 64-bit integers tightly, see :ref:`PackedInt64Array`. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_packedint64array.rst b/classes/class_packedint64array.rst index 661cf110f61..8b710ef908d 100644 --- a/classes/class_packedint64array.rst +++ b/classes/class_packedint64array.rst @@ -21,6 +21,10 @@ An array specifically designed to hold 64-bit integer values. Packs data tightly \ **Note:** This type stores signed 64-bit integers, which means it can take values in the interval ``[-2^63, 2^63 - 1]``, i.e. ``[-9223372036854775808, 9223372036854775807]``. Exceeding those bounds will wrap around. If you only need to pack 32-bit integers tightly, see :ref:`PackedInt32Array` for a more memory-friendly alternative. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_packedstringarray.rst b/classes/class_packedstringarray.rst index 3eae67d1da6..b623f3e9ec0 100644 --- a/classes/class_packedstringarray.rst +++ b/classes/class_packedstringarray.rst @@ -27,6 +27,10 @@ If you want to join the strings in the array, use :ref:`String.join`. Packs data tightly, so it saves memory for large array sizes. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_packedvector3array.rst b/classes/class_packedvector3array.rst index 098916a1c69..e6072f8f31a 100644 --- a/classes/class_packedvector3array.rst +++ b/classes/class_packedvector3array.rst @@ -19,6 +19,10 @@ Description An array specifically designed to hold :ref:`Vector3`. Packs data tightly, so it saves memory for large array sizes. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_physicalbone2d.rst b/classes/class_physicalbone2d.rst index ad8f7a67a3b..4464986d426 100644 --- a/classes/class_physicalbone2d.rst +++ b/classes/class_physicalbone2d.rst @@ -113,7 +113,7 @@ The index of the :ref:`Bone2D` that this **PhysicalBone2D** should - void **set_bone2d_nodepath** **(** :ref:`NodePath` value **)** - :ref:`NodePath` **get_bone2d_nodepath** **(** **)** -The :ref:`NodePath` to the :ref:`Bone2D` that this **PhysicalBone2D** isshould simulate. +The :ref:`NodePath` to the :ref:`Bone2D` that this **PhysicalBone2D** should simulate. .. rst-class:: classref-item-separator diff --git a/classes/class_projection.rst b/classes/class_projection.rst index ffed994780c..95077427a24 100644 --- a/classes/class_projection.rst +++ b/classes/class_projection.rst @@ -23,6 +23,10 @@ For purely linear transformations (translation, rotation, and scale), it is reco Used internally as :ref:`Camera3D`'s projection matrix. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_quaternion.rst b/classes/class_quaternion.rst index 5f13349915b..91f939171a2 100644 --- a/classes/class_quaternion.rst +++ b/classes/class_quaternion.rst @@ -23,6 +23,10 @@ Quaternions can be parametrized using both an axis-angle pair or Euler angles. D \ **Note:** Quaternions need to be normalized before being used for rotation. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_raycast3d.rst b/classes/class_raycast3d.rst index 2437a48c481..008b91e94e2 100644 --- a/classes/class_raycast3d.rst +++ b/classes/class_raycast3d.rst @@ -59,6 +59,8 @@ Properties +-------------------------------+------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`exclude_parent` | ``true`` | +-------------------------------+------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`hit_back_faces` | ``true`` | + +-------------------------------+------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`hit_from_inside` | ``false`` | +-------------------------------+------------------------------------------------------------------------------------+-----------------------+ | :ref:`Vector3` | :ref:`target_position` | ``Vector3(0, -1, 0)`` | @@ -232,6 +234,23 @@ If ``true``, collisions will be ignored for this RayCast3D's immediate parent. ---- +.. _class_RayCast3D_property_hit_back_faces: + +.. rst-class:: classref-property + +:ref:`bool` **hit_back_faces** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_hit_back_faces** **(** :ref:`bool` value **)** +- :ref:`bool` **is_hit_back_faces_enabled** **(** **)** + +If ``true``, the ray will hit back faces with concave polygon shapes with back face enabled or heightmap shapes. + +.. rst-class:: classref-item-separator + +---- + .. _class_RayCast3D_property_hit_from_inside: .. rst-class:: classref-property diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index c1edf2ce4fc..4a9f10bae1b 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -25,6 +25,10 @@ The 3D counterpart to **Rect2** is :ref:`AABB`. Negative values for :ref:`size` are not supported and will not work for most methods. Use :ref:`abs` to get a Rect2 with a positive size. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_rect2i.rst b/classes/class_rect2i.rst index de215463f93..e161e72bac8 100644 --- a/classes/class_rect2i.rst +++ b/classes/class_rect2i.rst @@ -23,6 +23,10 @@ It uses integer coordinates. If you need floating-point coordinates, use :ref:`R Negative values for :ref:`size` are not supported and will not work for most methods. Use :ref:`abs` to get a Rect2i with a positive size. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index f220b84b57f..ead2d81bc68 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -3214,6 +3214,10 @@ Draws the shadow atlas that stores shadows from :ref:`OmniLight3D`\ s in the upper left quadrant of the :ref:`Viewport`. +The slice of the camera frustum related to the shadow map cascade is superimposed to visualize coverage. The color of each slice matches the colors used for :ref:`VIEWPORT_DEBUG_DRAW_PSSM_SPLITS`. When shadow cascades are blended the overlap is taken into account when drawing the frustum slices. + +The last cascade shows all frustum slices to illustrate the coverage of all slices. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE: .. rst-class:: classref-enumeration-constant diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index 083ebaaa501..f896ace5797 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -12,7 +12,7 @@ ResourceImporter **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`EditorImportPlugin` +**Inherited By:** :ref:`EditorImportPlugin`, :ref:`ResourceImporterBitMap`, :ref:`ResourceImporterBMFont`, :ref:`ResourceImporterCSVTranslation`, :ref:`ResourceImporterDynamicFont`, :ref:`ResourceImporterImage`, :ref:`ResourceImporterImageFont`, :ref:`ResourceImporterLayeredTexture`, :ref:`ResourceImporterMP3`, :ref:`ResourceImporterOBJ`, :ref:`ResourceImporterOggVorbis`, :ref:`ResourceImporterScene`, :ref:`ResourceImporterShaderFile`, :ref:`ResourceImporterTexture`, :ref:`ResourceImporterTextureAtlas`, :ref:`ResourceImporterWAV` Base class for resource importers. diff --git a/classes/class_resourceimporterbitmap.rst b/classes/class_resourceimporterbitmap.rst new file mode 100644 index 00000000000..17dbf6c7c49 --- /dev/null +++ b/classes/class_resourceimporterbitmap.rst @@ -0,0 +1,72 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterBitMap.xml. + +.. _class_ResourceImporterBitMap: + +ResourceImporterBitMap +====================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+-----------------------------------------------------------------------+---------+ + | :ref:`int` | :ref:`create_from` | ``0`` | + +---------------------------+-----------------------------------------------------------------------+---------+ + | :ref:`float` | :ref:`threshold` | ``0.5`` | + +---------------------------+-----------------------------------------------------------------------+---------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterBitMap_property_create_from: + +.. rst-class:: classref-property + +:ref:`int` **create_from** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterBitMap_property_threshold: + +.. rst-class:: classref-property + +:ref:`float` **threshold** = ``0.5`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporterbmfont.rst b/classes/class_resourceimporterbmfont.rst new file mode 100644 index 00000000000..9bd03dc2065 --- /dev/null +++ b/classes/class_resourceimporterbmfont.rst @@ -0,0 +1,72 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterBMFont.xml. + +.. _class_ResourceImporterBMFont: + +ResourceImporterBMFont +====================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+-------------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`compress` | ``true`` | + +---------------------------+-------------------------------------------------------------------+----------+ + | :ref:`Array` | :ref:`fallbacks` | ``[]`` | + +---------------------------+-------------------------------------------------------------------+----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterBMFont_property_compress: + +.. rst-class:: classref-property + +:ref:`bool` **compress** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterBMFont_property_fallbacks: + +.. rst-class:: classref-property + +:ref:`Array` **fallbacks** = ``[]`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimportercsvtranslation.rst b/classes/class_resourceimportercsvtranslation.rst new file mode 100644 index 00000000000..ecdeff021ff --- /dev/null +++ b/classes/class_resourceimportercsvtranslation.rst @@ -0,0 +1,72 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterCSVTranslation.xml. + +.. _class_ResourceImporterCSVTranslation: + +ResourceImporterCSVTranslation +============================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+---------------------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`compress` | ``true`` | + +-------------------------+---------------------------------------------------------------------------+----------+ + | :ref:`int` | :ref:`delimiter` | ``0`` | + +-------------------------+---------------------------------------------------------------------------+----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterCSVTranslation_property_compress: + +.. rst-class:: classref-property + +:ref:`bool` **compress** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterCSVTranslation_property_delimiter: + +.. rst-class:: classref-property + +:ref:`int` **delimiter** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporterdynamicfont.rst b/classes/class_resourceimporterdynamicfont.rst new file mode 100644 index 00000000000..1a6a4eb7788 --- /dev/null +++ b/classes/class_resourceimporterdynamicfont.rst @@ -0,0 +1,296 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterDynamicFont.xml. + +.. _class_ResourceImporterDynamicFont: + +ResourceImporterDynamicFont +=========================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`allow_system_fallback` | ``true`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`antialiasing` | ``1`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`compress` | ``true`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`Array` | :ref:`fallbacks` | ``[]`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`force_autohinter` | ``false`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`generate_mipmaps` | ``false`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`hinting` | ``1`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`Dictionary` | :ref:`language_support` | ``{}`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`msdf_pixel_range` | ``8`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`msdf_size` | ``48`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`multichannel_signed_distance_field` | ``false`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`Dictionary` | :ref:`opentype_features` | ``{}`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`oversampling` | ``0.0`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`Array` | :ref:`preload` | ``[]`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`Dictionary` | :ref:`script_support` | ``{}`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`subpixel_positioning` | ``1`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterDynamicFont_property_allow_system_fallback: + +.. rst-class:: classref-property + +:ref:`bool` **allow_system_fallback** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_antialiasing: + +.. rst-class:: classref-property + +:ref:`int` **antialiasing** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_compress: + +.. rst-class:: classref-property + +:ref:`bool` **compress** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_fallbacks: + +.. rst-class:: classref-property + +:ref:`Array` **fallbacks** = ``[]`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_force_autohinter: + +.. rst-class:: classref-property + +:ref:`bool` **force_autohinter** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_generate_mipmaps: + +.. rst-class:: classref-property + +:ref:`bool` **generate_mipmaps** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_hinting: + +.. rst-class:: classref-property + +:ref:`int` **hinting** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_language_support: + +.. rst-class:: classref-property + +:ref:`Dictionary` **language_support** = ``{}`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_msdf_pixel_range: + +.. rst-class:: classref-property + +:ref:`int` **msdf_pixel_range** = ``8`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_msdf_size: + +.. rst-class:: classref-property + +:ref:`int` **msdf_size** = ``48`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_multichannel_signed_distance_field: + +.. rst-class:: classref-property + +:ref:`bool` **multichannel_signed_distance_field** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_opentype_features: + +.. rst-class:: classref-property + +:ref:`Dictionary` **opentype_features** = ``{}`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_oversampling: + +.. rst-class:: classref-property + +:ref:`float` **oversampling** = ``0.0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_preload: + +.. rst-class:: classref-property + +:ref:`Array` **preload** = ``[]`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_script_support: + +.. rst-class:: classref-property + +:ref:`Dictionary` **script_support** = ``{}`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterDynamicFont_property_subpixel_positioning: + +.. rst-class:: classref-property + +:ref:`int` **subpixel_positioning** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporterimage.rst b/classes/class_resourceimporterimage.rst new file mode 100644 index 00000000000..3e341059a91 --- /dev/null +++ b/classes/class_resourceimporterimage.rst @@ -0,0 +1,25 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterImage.xml. + +.. _class_ResourceImporterImage: + +ResourceImporterImage +===================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporterimagefont.rst b/classes/class_resourceimporterimagefont.rst new file mode 100644 index 00000000000..60cfd80ceb7 --- /dev/null +++ b/classes/class_resourceimporterimagefont.rst @@ -0,0 +1,152 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterImageFont.xml. + +.. _class_ResourceImporterImageFont: + +ResourceImporterImageFont +========================= + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Rect2i` | :ref:`character_margin` | ``Rect2i(0, 0, 0, 0)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + | :ref:`PackedStringArray` | :ref:`character_ranges` | ``PackedStringArray()`` | + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`columns` | ``1`` | + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`compress` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Array` | :ref:`fallbacks` | ``[]`` | + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Rect2i` | :ref:`image_margin` | ``Rect2i(0, 0, 0, 0)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`rows` | ``1`` | + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterImageFont_property_character_margin: + +.. rst-class:: classref-property + +:ref:`Rect2i` **character_margin** = ``Rect2i(0, 0, 0, 0)`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterImageFont_property_character_ranges: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **character_ranges** = ``PackedStringArray()`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterImageFont_property_columns: + +.. rst-class:: classref-property + +:ref:`int` **columns** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterImageFont_property_compress: + +.. rst-class:: classref-property + +:ref:`bool` **compress** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterImageFont_property_fallbacks: + +.. rst-class:: classref-property + +:ref:`Array` **fallbacks** = ``[]`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterImageFont_property_image_margin: + +.. rst-class:: classref-property + +:ref:`Rect2i` **image_margin** = ``Rect2i(0, 0, 0, 0)`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterImageFont_property_rows: + +.. rst-class:: classref-property + +:ref:`int` **rows** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporterlayeredtexture.rst b/classes/class_resourceimporterlayeredtexture.rst new file mode 100644 index 00000000000..84f02c3a4cf --- /dev/null +++ b/classes/class_resourceimporterlayeredtexture.rst @@ -0,0 +1,168 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterLayeredTexture.xml. + +.. _class_ResourceImporterLayeredTexture: + +ResourceImporterLayeredTexture +============================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/channel_pack` | ``0`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/hdr_compression` | ``1`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`compress/high_quality` | ``false`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`compress/lossy_quality` | ``0.7`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/mode` | ``1`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`mipmaps/generate` | ``true`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`mipmaps/limit` | ``-1`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`slices/arrangement` | ``1`` | + +---------------------------+---------------------------------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterLayeredTexture_property_compress/channel_pack: + +.. rst-class:: classref-property + +:ref:`int` **compress/channel_pack** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_compress/hdr_compression: + +.. rst-class:: classref-property + +:ref:`int` **compress/hdr_compression** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_compress/high_quality: + +.. rst-class:: classref-property + +:ref:`bool` **compress/high_quality** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_compress/lossy_quality: + +.. rst-class:: classref-property + +:ref:`float` **compress/lossy_quality** = ``0.7`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_compress/mode: + +.. rst-class:: classref-property + +:ref:`int` **compress/mode** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_mipmaps/generate: + +.. rst-class:: classref-property + +:ref:`bool` **mipmaps/generate** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_mipmaps/limit: + +.. rst-class:: classref-property + +:ref:`int` **mipmaps/limit** = ``-1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterLayeredTexture_property_slices/arrangement: + +.. rst-class:: classref-property + +:ref:`int` **slices/arrangement** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimportermp3.rst b/classes/class_resourceimportermp3.rst new file mode 100644 index 00000000000..8215ef03e3d --- /dev/null +++ b/classes/class_resourceimportermp3.rst @@ -0,0 +1,118 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/ResourceImporterMP3.xml. + +.. _class_ResourceImporterMP3: + +ResourceImporterMP3 +=================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+--------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`bar_beats` | ``4`` | + +---------------------------+--------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`beat_count` | ``0`` | + +---------------------------+--------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`bpm` | ``0`` | + +---------------------------+--------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`loop` | ``false`` | + +---------------------------+--------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`loop_offset` | ``0`` | + +---------------------------+--------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterMP3_property_bar_beats: + +.. rst-class:: classref-property + +:ref:`int` **bar_beats** = ``4`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterMP3_property_beat_count: + +.. rst-class:: classref-property + +:ref:`int` **beat_count** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterMP3_property_bpm: + +.. rst-class:: classref-property + +:ref:`float` **bpm** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterMP3_property_loop: + +.. rst-class:: classref-property + +:ref:`bool` **loop** = ``false`` + +If ``true``, the audio will play again from the specified :ref:`loop_offset` once it is done playing. Useful for ambient sounds and background music. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterMP3_property_loop_offset: + +.. rst-class:: classref-property + +:ref:`float` **loop_offset** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporterobj.rst b/classes/class_resourceimporterobj.rst new file mode 100644 index 00000000000..ca092db4e24 --- /dev/null +++ b/classes/class_resourceimporterobj.rst @@ -0,0 +1,104 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterOBJ.xml. + +.. _class_ResourceImporterOBJ: + +ResourceImporterOBJ +=================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------+--------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`generate_tangents` | ``true`` | + +-------------------------------+--------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`offset_mesh` | ``Vector3(0, 0, 0)`` | + +-------------------------------+--------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`optimize_mesh` | ``true`` | + +-------------------------------+--------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`scale_mesh` | ``Vector3(1, 1, 1)`` | + +-------------------------------+--------------------------------------------------------------------------------+----------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterOBJ_property_generate_tangents: + +.. rst-class:: classref-property + +:ref:`bool` **generate_tangents** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterOBJ_property_offset_mesh: + +.. rst-class:: classref-property + +:ref:`Vector3` **offset_mesh** = ``Vector3(0, 0, 0)`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterOBJ_property_optimize_mesh: + +.. rst-class:: classref-property + +:ref:`bool` **optimize_mesh** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterOBJ_property_scale_mesh: + +.. rst-class:: classref-property + +:ref:`Vector3` **scale_mesh** = ``Vector3(1, 1, 1)`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst new file mode 100644 index 00000000000..9b0057c6af9 --- /dev/null +++ b/classes/class_resourceimporteroggvorbis.rst @@ -0,0 +1,118 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/vorbis/doc_classes/ResourceImporterOggVorbis.xml. + +.. _class_ResourceImporterOggVorbis: + +ResourceImporterOggVorbis +========================= + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+--------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`bar_beats` | ``4`` | + +---------------------------+--------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`beat_count` | ``0`` | + +---------------------------+--------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`bpm` | ``0`` | + +---------------------------+--------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`loop` | ``false`` | + +---------------------------+--------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`loop_offset` | ``0`` | + +---------------------------+--------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterOggVorbis_property_bar_beats: + +.. rst-class:: classref-property + +:ref:`int` **bar_beats** = ``4`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterOggVorbis_property_beat_count: + +.. rst-class:: classref-property + +:ref:`int` **beat_count** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterOggVorbis_property_bpm: + +.. rst-class:: classref-property + +:ref:`float` **bpm** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterOggVorbis_property_loop: + +.. rst-class:: classref-property + +:ref:`bool` **loop** = ``false`` + +If ``true``, the audio will play again from the specified :ref:`loop_offset` once it is done playing. Useful for ambient sounds and background music. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterOggVorbis_property_loop_offset: + +.. rst-class:: classref-property + +:ref:`float` **loop_offset** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporterscene.rst b/classes/class_resourceimporterscene.rst new file mode 100644 index 00000000000..98a4f973746 --- /dev/null +++ b/classes/class_resourceimporterscene.rst @@ -0,0 +1,296 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterScene.xml. + +.. _class_ResourceImporterScene: + +ResourceImporterScene +===================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`Dictionary` | :ref:`_subresources` | ``{}`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`float` | :ref:`animation/fps` | ``30`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`animation/import` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`animation/remove_immutable_tracks` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`animation/trimming` | ``false`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`String` | :ref:`import_script/path` | ``""`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`meshes/create_shadow_meshes` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`meshes/ensure_tangents` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`meshes/generate_lods` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`int` | :ref:`meshes/light_baking` | ``1`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`float` | :ref:`meshes/lightmap_texel_size` | ``0.2`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`nodes/apply_root_scale` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`String` | :ref:`nodes/root_name` | ``"Scene Root"`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`float` | :ref:`nodes/root_scale` | ``1.0`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`String` | :ref:`nodes/root_type` | ``"Node3D"`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + | :ref:`bool` | :ref:`skins/use_named_skins` | ``true`` | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------+------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterScene_property__subresources: + +.. rst-class:: classref-property + +:ref:`Dictionary` **_subresources** = ``{}`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_animation/fps: + +.. rst-class:: classref-property + +:ref:`float` **animation/fps** = ``30`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_animation/import: + +.. rst-class:: classref-property + +:ref:`bool` **animation/import** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_animation/remove_immutable_tracks: + +.. rst-class:: classref-property + +:ref:`bool` **animation/remove_immutable_tracks** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_animation/trimming: + +.. rst-class:: classref-property + +:ref:`bool` **animation/trimming** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_import_script/path: + +.. rst-class:: classref-property + +:ref:`String` **import_script/path** = ``""`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_meshes/create_shadow_meshes: + +.. rst-class:: classref-property + +:ref:`bool` **meshes/create_shadow_meshes** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_meshes/ensure_tangents: + +.. rst-class:: classref-property + +:ref:`bool` **meshes/ensure_tangents** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_meshes/generate_lods: + +.. rst-class:: classref-property + +:ref:`bool` **meshes/generate_lods** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_meshes/light_baking: + +.. rst-class:: classref-property + +:ref:`int` **meshes/light_baking** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_meshes/lightmap_texel_size: + +.. rst-class:: classref-property + +:ref:`float` **meshes/lightmap_texel_size** = ``0.2`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_nodes/apply_root_scale: + +.. rst-class:: classref-property + +:ref:`bool` **nodes/apply_root_scale** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_nodes/root_name: + +.. rst-class:: classref-property + +:ref:`String` **nodes/root_name** = ``"Scene Root"`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_nodes/root_scale: + +.. rst-class:: classref-property + +:ref:`float` **nodes/root_scale** = ``1.0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_nodes/root_type: + +.. rst-class:: classref-property + +:ref:`String` **nodes/root_type** = ``"Node3D"`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterScene_property_skins/use_named_skins: + +.. rst-class:: classref-property + +:ref:`bool` **skins/use_named_skins** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimportershaderfile.rst b/classes/class_resourceimportershaderfile.rst new file mode 100644 index 00000000000..fb3d2a09baa --- /dev/null +++ b/classes/class_resourceimportershaderfile.rst @@ -0,0 +1,25 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterShaderFile.xml. + +.. _class_ResourceImporterShaderFile: + +ResourceImporterShaderFile +========================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimportertexture.rst b/classes/class_resourceimportertexture.rst new file mode 100644 index 00000000000..21821771244 --- /dev/null +++ b/classes/class_resourceimportertexture.rst @@ -0,0 +1,360 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterTexture.xml. + +.. _class_ResourceImporterTexture: + +ResourceImporterTexture +======================= + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/channel_pack` | ``0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/hdr_compression` | ``1`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`compress/high_quality` | ``false`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`compress/lossy_quality` | ``0.7`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/mode` | ``0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/normal_map` | ``0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`detect_3d/compress_to` | ``1`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`editor/convert_colors_with_editor_theme` | ``false`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`editor/scale_with_editor_scale` | ``false`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`mipmaps/generate` | ``false`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`mipmaps/limit` | ``-1`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`process/fix_alpha_border` | ``true`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`process/hdr_as_srgb` | ``false`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`process/hdr_clamp_exposure` | ``false`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`process/normal_map_invert_y` | ``false`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`process/premult_alpha` | ``false`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`process/size_limit` | ``0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`roughness/mode` | ``0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`roughness/src_normal` | ``""`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`svg/scale` | ``1.0`` | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterTexture_property_compress/channel_pack: + +.. rst-class:: classref-property + +:ref:`int` **compress/channel_pack** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_compress/hdr_compression: + +.. rst-class:: classref-property + +:ref:`int` **compress/hdr_compression** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_compress/high_quality: + +.. rst-class:: classref-property + +:ref:`bool` **compress/high_quality** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_compress/lossy_quality: + +.. rst-class:: classref-property + +:ref:`float` **compress/lossy_quality** = ``0.7`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_compress/mode: + +.. rst-class:: classref-property + +:ref:`int` **compress/mode** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_compress/normal_map: + +.. rst-class:: classref-property + +:ref:`int` **compress/normal_map** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_detect_3d/compress_to: + +.. rst-class:: classref-property + +:ref:`int` **detect_3d/compress_to** = ``1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_editor/convert_colors_with_editor_theme: + +.. rst-class:: classref-property + +:ref:`bool` **editor/convert_colors_with_editor_theme** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_editor/scale_with_editor_scale: + +.. rst-class:: classref-property + +:ref:`bool` **editor/scale_with_editor_scale** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_mipmaps/generate: + +.. rst-class:: classref-property + +:ref:`bool` **mipmaps/generate** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_mipmaps/limit: + +.. rst-class:: classref-property + +:ref:`int` **mipmaps/limit** = ``-1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/fix_alpha_border: + +.. rst-class:: classref-property + +:ref:`bool` **process/fix_alpha_border** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/hdr_as_srgb: + +.. rst-class:: classref-property + +:ref:`bool` **process/hdr_as_srgb** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/hdr_clamp_exposure: + +.. rst-class:: classref-property + +:ref:`bool` **process/hdr_clamp_exposure** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/normal_map_invert_y: + +.. rst-class:: classref-property + +:ref:`bool` **process/normal_map_invert_y** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/premult_alpha: + +.. rst-class:: classref-property + +:ref:`bool` **process/premult_alpha** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_process/size_limit: + +.. rst-class:: classref-property + +:ref:`int` **process/size_limit** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_roughness/mode: + +.. rst-class:: classref-property + +:ref:`int` **roughness/mode** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_roughness/src_normal: + +.. rst-class:: classref-property + +:ref:`String` **roughness/src_normal** = ``""`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTexture_property_svg/scale: + +.. rst-class:: classref-property + +:ref:`float` **svg/scale** = ``1.0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimportertextureatlas.rst b/classes/class_resourceimportertextureatlas.rst new file mode 100644 index 00000000000..bd13154f678 --- /dev/null +++ b/classes/class_resourceimportertextureatlas.rst @@ -0,0 +1,104 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterTextureAtlas.xml. + +.. _class_ResourceImporterTextureAtlas: + +ResourceImporterTextureAtlas +============================ + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`atlas_file` | ``""`` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`crop_to_region` | ``false`` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`import_mode` | ``0`` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`trim_alpha_border_from_region` | ``true`` | + +-----------------------------+-----------------------------------------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterTextureAtlas_property_atlas_file: + +.. rst-class:: classref-property + +:ref:`String` **atlas_file** = ``""`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTextureAtlas_property_crop_to_region: + +.. rst-class:: classref-property + +:ref:`bool` **crop_to_region** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTextureAtlas_property_import_mode: + +.. rst-class:: classref-property + +:ref:`int` **import_mode** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterTextureAtlas_property_trim_alpha_border_from_region: + +.. rst-class:: classref-property + +:ref:`bool` **trim_alpha_border_from_region** = ``true`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceimporterwav.rst b/classes/class_resourceimporterwav.rst new file mode 100644 index 00000000000..53daddad618 --- /dev/null +++ b/classes/class_resourceimporterwav.rst @@ -0,0 +1,200 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceImporterWAV.xml. + +.. _class_ResourceImporterWAV: + +ResourceImporterWAV +=================== + +**Inherits:** :ref:`ResourceImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`compress/mode` | ``0`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`edit/loop_begin` | ``0`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`edit/loop_end` | ``-1`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`edit/loop_mode` | ``0`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`edit/normalize` | ``false`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`edit/trim` | ``false`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`force/8_bit` | ``false`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`force/max_rate` | ``false`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`float` | :ref:`force/max_rate_hz` | ``44100`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`force/mono` | ``false`` | + +---------------------------+--------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_ResourceImporterWAV_property_compress/mode: + +.. rst-class:: classref-property + +:ref:`int` **compress/mode** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_edit/loop_begin: + +.. rst-class:: classref-property + +:ref:`int` **edit/loop_begin** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_edit/loop_end: + +.. rst-class:: classref-property + +:ref:`int` **edit/loop_end** = ``-1`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_edit/loop_mode: + +.. rst-class:: classref-property + +:ref:`int` **edit/loop_mode** = ``0`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_edit/normalize: + +.. rst-class:: classref-property + +:ref:`bool` **edit/normalize** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_edit/trim: + +.. rst-class:: classref-property + +:ref:`bool` **edit/trim** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_force/8_bit: + +.. rst-class:: classref-property + +:ref:`bool` **force/8_bit** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_force/max_rate: + +.. rst-class:: classref-property + +:ref:`bool` **force/max_rate** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_force/max_rate_hz: + +.. rst-class:: classref-property + +:ref:`float` **force/max_rate_hz** = ``44100`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterWAV_property_force/mono: + +.. rst-class:: classref-property + +:ref:`bool` **force/mono** = ``false`` + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index aa6327c63c9..10f8ffba7e9 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -192,6 +192,14 @@ An optional ``type_hint`` can be used to further specify the :ref:`Resource` to get their components. + +:: + + for dep in ResourceLoader.get_dependencies(path): + print(dep.get_slice("::", 0)) # Prints UID. + print(dep.get_slice("::", 2)) # Prints path. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 951282e7406..200093674c4 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -167,6 +167,10 @@ Methods +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pop` **(** **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`pop_all` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`pop_context` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_bgcolor` **(** :ref:`Color` bgcolor **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_bold` **(** **)** | @@ -177,13 +181,15 @@ Methods +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_color` **(** :ref:`Color` color **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`push_context` **(** **)** | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_customfx` **(** :ref:`RichTextEffect` effect, :ref:`Dictionary` env **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_dropcap` **(** :ref:`String` string, :ref:`Font` font, :ref:`int` size, :ref:`Rect2` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`Color` color=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_color=Color(0, 0, 0, 0) **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_fgcolor` **(** :ref:`Color` fgcolor **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_font` **(** :ref:`Font` font, :ref:`int` font_size **)** | + | void | :ref:`push_font` **(** :ref:`Font` font, :ref:`int` font_size=0 **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_font_size` **(** :ref:`int` font_size **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -231,7 +237,7 @@ Methods +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell_size_override` **(** :ref:`Vector2` min_size, :ref:`Vector2` max_size **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | + | void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio=1 **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -1286,6 +1292,30 @@ Terminates the current tag. Use after ``push_*`` methods to close BBCodes manual ---- +.. _class_RichTextLabel_method_pop_all: + +.. rst-class:: classref-method + +void **pop_all** **(** **)** + +Terminates all tags opened by ``push_*`` methods. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RichTextLabel_method_pop_context: + +.. rst-class:: classref-method + +void **pop_context** **(** **)** + +Terminates tags opened after the last :ref:`push_context` call (including context marker), or all tags if there's no context marker on the stack. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_push_bgcolor: .. rst-class:: classref-method @@ -1346,6 +1376,18 @@ Adds a ``[color]`` tag to the tag stack. ---- +.. _class_RichTextLabel_method_push_context: + +.. rst-class:: classref-method + +void **push_context** **(** **)** + +Adds a context marker to the tag stack. See :ref:`pop_context`. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_push_customfx: .. rst-class:: classref-method @@ -1386,10 +1428,12 @@ Adds a ``[fgcolor]`` tag to the tag stack. .. rst-class:: classref-method -void **push_font** **(** :ref:`Font` font, :ref:`int` font_size **)** +void **push_font** **(** :ref:`Font` font, :ref:`int` font_size=0 **)** Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. +Passing ``0`` to ``font_size`` will use the existing default font size. + .. rst-class:: classref-item-separator ---- @@ -1678,7 +1722,7 @@ Sets minimum and maximum size overrides for a table cell. .. rst-class:: classref-method -void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** +void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio=1 **)** Edits the selected column's expansion options. If ``expand`` is ``true``, the column expands in proportion to its expansion ratio versus the other columns' ratios. diff --git a/classes/class_rid.rst b/classes/class_rid.rst index 656a6476539..070bc918c97 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -21,6 +21,10 @@ The RID :ref:`Variant` type is used to access a low-level resourc A low-level resource may correspond to a high-level :ref:`Resource`, such as :ref:`Texture` or :ref:`Mesh`. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-reftable-group Constructors diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 38d697e03f0..fd040d4b40f 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -500,7 +500,7 @@ See :ref:`add_constant_torque`. - void **set_contact_monitor** **(** :ref:`bool` value **)** - :ref:`bool` **is_contact_monitor_enabled** **(** **)** -If ``true``, the RigidBody2D will emit signals when it collides with another RigidBody2D. +If ``true``, the RigidBody2D will emit signals when it collides with another body. \ **Note:** By default the maximum contacts reported is set to 0, meaning nothing will be recorded, see :ref:`max_contacts_reported`. diff --git a/classes/class_rigidbody3d.rst b/classes/class_rigidbody3d.rst index b85be2c0efe..74dccf6d74a 100644 --- a/classes/class_rigidbody3d.rst +++ b/classes/class_rigidbody3d.rst @@ -470,7 +470,7 @@ See :ref:`add_constant_torque`. - void **set_contact_monitor** **(** :ref:`bool` value **)** - :ref:`bool` **is_contact_monitor_enabled** **(** **)** -If ``true``, the RigidBody3D will emit signals when it collides with another RigidBody3D. +If ``true``, the RigidBody3D will emit signals when it collides with another body. \ **Note:** By default the maximum contacts reported is set to 0, meaning nothing will be recorded, see :ref:`max_contacts_reported`. diff --git a/classes/class_signal.rst b/classes/class_signal.rst index e0b9593f072..8a9823cc454 100644 --- a/classes/class_signal.rst +++ b/classes/class_signal.rst @@ -44,6 +44,10 @@ In GDScript, signals can be declared with the ``signal`` keyword. In C#, you may +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_string.rst b/classes/class_string.rst index bcdd862e31a..a1cd1bfdf84 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -23,6 +23,10 @@ Some string methods have corresponding variations. Variations suffixed with ``n` \ **Note:** In a boolean context, a string will evaluate to ``false`` if it is empty (``""``). Otherwise, a string will always evaluate to ``true``. The ``not`` operator cannot be used. Instead, :ref:`is_empty` should be used to check for empty strings. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials @@ -1780,11 +1784,11 @@ Converts the string representing a decimal number into a :ref:`float` **validate_node_name** **(** **)** |const| -Returns a copy of the string with all characters that are not allowed in :ref:`Node.name` removed (``.`` ``:`` ``@`` ``/`` ``"`` ``%``). +Returns a copy of the string with all characters that are not allowed in :ref:`Node.name` (``.`` ``:`` ``@`` ``/`` ``"`` ``%``) replaced with underscores. .. rst-class:: classref-item-separator diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index bbc09ef6a4d..27d0d4bfc97 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -1860,7 +1860,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`i :ref:`String` **validate_node_name** **(** **)** |const| -Returns a copy of the string with all characters that are not allowed in :ref:`Node.name` removed (``.`` ``:`` ``@`` ``/`` ``"`` ``%``). +Returns a copy of the string with all characters that are not allowed in :ref:`Node.name` (``.`` ``:`` ``@`` ``/`` ``"`` ``%``) replaced with underscores. .. rst-class:: classref-item-separator diff --git a/classes/class_tilesetatlassource.rst b/classes/class_tilesetatlassource.rst index 22a12bb63ee..5668d9a3945 100644 --- a/classes/class_tilesetatlassource.rst +++ b/classes/class_tilesetatlassource.rst @@ -57,61 +57,104 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_alternative_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_id_override=-1 **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` size=Vector2i(1, 1) **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_atlas_grid_size` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_next_alternative_tile_id` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_runtime_texture` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_runtime_tile_texture_region` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tile_animation_columns` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_tile_animation_frame_duration` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_index **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tile_animation_frames_count` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_tile_animation_separation` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_tile_animation_speed` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_tile_animation_total_duration` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_tile_at_coords` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TileData` | :ref:`get_tile_data` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_tile_size_in_atlas` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_tile_texture_region` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame=0 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_tiles_to_be_removed_on_change` **(** :ref:`Texture2D` texture, :ref:`Vector2i` margins, :ref:`Vector2i` separation, :ref:`Vector2i` texture_region_size **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_room_for_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` size, :ref:`int` animation_columns, :ref:`Vector2i` animation_separation, :ref:`int` frames_count, :ref:`Vector2i` ignored_tile=Vector2i(-1, -1) **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_tile_in_atlas` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i` new_size=Vector2i(-1, -1) **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_alternative_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_tile` **(** :ref:`Vector2i` atlas_coords **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_alternative_tile_id` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile, :ref:`int` new_id **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_columns` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_columns **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_frame_duration` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_index, :ref:`float` duration **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_frames_count` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frames_count **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_separation` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` separation **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_speed` **(** :ref:`Vector2i` atlas_coords, :ref:`float` speed **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_alternative_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_id_override=-1 **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` size=Vector2i(1, 1) **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_atlas_grid_size` **(** **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_alternative_tile_id` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_runtime_texture` **(** **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_runtime_tile_texture_region` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tile_animation_columns` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_tile_animation_frame_duration` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_index **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tile_animation_frames_count` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileAnimationMode` | :ref:`get_tile_animation_mode` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_tile_animation_separation` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_tile_animation_speed` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_tile_animation_total_duration` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_tile_at_coords` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileData` | :ref:`get_tile_data` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_tile_size_in_atlas` **(** :ref:`Vector2i` atlas_coords **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_tile_texture_region` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame=0 **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_tiles_to_be_removed_on_change` **(** :ref:`Texture2D` texture, :ref:`Vector2i` margins, :ref:`Vector2i` separation, :ref:`Vector2i` texture_region_size **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_room_for_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` size, :ref:`int` animation_columns, :ref:`Vector2i` animation_separation, :ref:`int` frames_count, :ref:`Vector2i` ignored_tile=Vector2i(-1, -1) **)** |const| | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`move_tile_in_atlas` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i` new_size=Vector2i(-1, -1) **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`remove_alternative_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`remove_tile` **(** :ref:`Vector2i` atlas_coords **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_alternative_tile_id` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile, :ref:`int` new_id **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tile_animation_columns` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_columns **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tile_animation_frame_duration` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_index, :ref:`float` duration **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tile_animation_frames_count` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frames_count **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tile_animation_mode` **(** :ref:`Vector2i` atlas_coords, :ref:`TileAnimationMode` mode **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tile_animation_separation` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` separation **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tile_animation_speed` **(** :ref:`Vector2i` atlas_coords, :ref:`float` speed **)** | + +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_TileSetAtlasSource_TileAnimationMode: + +.. rst-class:: classref-enumeration + +enum **TileAnimationMode**: + +.. _class_TileSetAtlasSource_constant_TILE_ANIMATION_MODE_DEFAULT: + +.. rst-class:: classref-enumeration-constant + +:ref:`TileAnimationMode` **TILE_ANIMATION_MODE_DEFAULT** = ``0`` + +Tile animations start at same time, looking identical. + +.. _class_TileSetAtlasSource_constant_TILE_ANIMATION_MODE_RANDOM_START_TIMES: + +.. rst-class:: classref-enumeration-constant + +:ref:`TileAnimationMode` **TILE_ANIMATION_MODE_RANDOM_START_TIMES** = ``1`` + +Tile animations start at random times, looking varied. + +.. _class_TileSetAtlasSource_constant_TILE_ANIMATION_MODE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`TileAnimationMode` **TILE_ANIMATION_MODE_MAX** = ``2`` + +Represents the size of the :ref:`TileAnimationMode` enum. .. rst-class:: classref-section-separator @@ -326,6 +369,18 @@ Returns how many animation frames has the tile at coordinates ``atlas_coords``. ---- +.. _class_TileSetAtlasSource_method_get_tile_animation_mode: + +.. rst-class:: classref-method + +:ref:`TileAnimationMode` **get_tile_animation_mode** **(** :ref:`Vector2i` atlas_coords **)** |const| + +Returns the :ref:`TileAnimationMode` of the tile at ``atlas_coords``. See also :ref:`set_tile_animation_mode`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileSetAtlasSource_method_get_tile_animation_separation: .. rst-class:: classref-method @@ -526,6 +581,18 @@ Sets how many animation frames the tile at coordinates ``atlas_coords`` has. ---- +.. _class_TileSetAtlasSource_method_set_tile_animation_mode: + +.. rst-class:: classref-method + +void **set_tile_animation_mode** **(** :ref:`Vector2i` atlas_coords, :ref:`TileAnimationMode` mode **)** + +Sets the :ref:`TileAnimationMode` of the tile at ``atlas_coords`` to ``mode``. See also :ref:`get_tile_animation_mode`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileSetAtlasSource_method_set_tile_animation_separation: .. rst-class:: classref-method diff --git a/classes/class_tlsoptions.rst b/classes/class_tlsoptions.rst index 7a47742ebdb..e544df1a038 100644 --- a/classes/class_tlsoptions.rst +++ b/classes/class_tlsoptions.rst @@ -74,7 +74,7 @@ Creates a TLS client configuration which validates certificates and their common You can specify a custom ``trusted_chain`` of certification authorities (the default CA list will be used if ``null``), and optionally provide a ``common_name_override`` if you expect the certificate to have a common name other then the server FQDN. -Note: On the Web plafrom, TLS verification is always enforced against the CA list of the web browser. This is considered a security feature. +\ **Note:** On the Web platform, TLS verification is always enforced against the CA list of the web browser. This is considered a security feature. .. rst-class:: classref-item-separator @@ -86,9 +86,9 @@ Note: On the Web plafrom, TLS verification is always enforced against the CA lis :ref:`TLSOptions` **client_unsafe** **(** :ref:`X509Certificate` trusted_chain=null **)** |static| -Creates an **unsafe** TLS client configuration where certificate validation is optional. You can optionally provide a valid ``trusted_chain``, but the common name of the certififcates will never be checked. Using this configuration for purposes other than testing **is not recommended**. +Creates an **unsafe** TLS client configuration where certificate validation is optional. You can optionally provide a valid ``trusted_chain``, but the common name of the certificates will never be checked. Using this configuration for purposes other than testing **is not recommended**. -Note: On the Web plafrom, TLS verification is always enforced against the CA list of the web browser. This is considered a security feature. +\ **Note:** On the Web platform, TLS verification is always enforced against the CA list of the web browser. This is considered a security feature. .. rst-class:: classref-item-separator @@ -102,7 +102,7 @@ Note: On the Web plafrom, TLS verification is always enforced against the CA lis Creates a TLS server configuration using the provided ``key`` and ``certificate``. -Note: The ``certificate`` should include the full certificate chain up to the signing CA (certificates file can be concatenated using a general purpose text editor). +\ **Note:** The ``certificate`` should include the full certificate chain up to the signing CA (certificates file can be concatenated using a general purpose text editor). .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 4a7f9ed4e06..1ada96f7e39 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -21,6 +21,10 @@ A 2×3 matrix (2 rows, 3 columns) used for 2D linear transformations. It can rep For more information, read the "Matrices and transforms" documentation article. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_transform3d.rst b/classes/class_transform3d.rst index f77aa605e2f..00d5abdd0ff 100644 --- a/classes/class_transform3d.rst +++ b/classes/class_transform3d.rst @@ -21,6 +21,10 @@ A 3×4 matrix (3 rows, 4 columns) used for 3D linear transformations. It can rep For more information, read the "Matrices and transforms" documentation article. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_tree.rst b/classes/class_tree.rst index cf185b05e97..fc6bc77318f 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -219,6 +219,14 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`icon_max_width` | ``0`` | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`inner_item_margin_bottom` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`inner_item_margin_left` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`inner_item_margin_right` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`inner_item_margin_top` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`item_margin` | ``16`` | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | @@ -1478,6 +1486,54 @@ The maximum allowed width of the icon in item's cells. This limit is applied on ---- +.. _class_Tree_theme_constant_inner_item_margin_bottom: + +.. rst-class:: classref-themeproperty + +:ref:`int` **inner_item_margin_bottom** = ``0`` + +The inner bottom margin of an item. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_constant_inner_item_margin_left: + +.. rst-class:: classref-themeproperty + +:ref:`int` **inner_item_margin_left** = ``0`` + +The inner left margin of an item. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_constant_inner_item_margin_right: + +.. rst-class:: classref-themeproperty + +:ref:`int` **inner_item_margin_right** = ``0`` + +The inner right margin of an item. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_constant_inner_item_margin_top: + +.. rst-class:: classref-themeproperty + +:ref:`int` **inner_item_margin_top** = ``0`` + +The inner top margin of an item. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_constant_item_margin: .. rst-class:: classref-themeproperty diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index f5dcf4820da..c8d48b70ded 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -184,6 +184,8 @@ Methods +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_button_disabled` **(** :ref:`int` column, :ref:`int` button_index, :ref:`bool` disabled **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_button_tooltip_text` **(** :ref:`int` column, :ref:`int` button_index, :ref:`String` tooltip **)** | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | @@ -1202,6 +1204,18 @@ If ``true``, disables the button at index ``button_index`` in the given ``column ---- +.. _class_TreeItem_method_set_button_tooltip_text: + +.. rst-class:: classref-method + +void **set_button_tooltip_text** **(** :ref:`int` column, :ref:`int` button_index, :ref:`String` tooltip **)** + +Sets the tooltip text for the button at index ``button_index`` in the given ``column``. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_set_cell_mode: .. rst-class:: classref-method diff --git a/classes/class_variant.rst b/classes/class_variant.rst index 1e051274400..4d90ce67aee 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -121,6 +121,10 @@ A Variant: Modifications to a container will modify all references to it. A :ref:`Mutex` should be created to lock it if multi-threaded access is desired. +.. note:: + + There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_videostreamplayer.rst b/classes/class_videostreamplayer.rst index e3e212dd220..4a062673020 100644 --- a/classes/class_videostreamplayer.rst +++ b/classes/class_videostreamplayer.rst @@ -46,6 +46,8 @@ Properties +---------------------------------------+--------------------------------------------------------------------------+---------------+ | :ref:`bool` | :ref:`expand` | ``false`` | +---------------------------------------+--------------------------------------------------------------------------+---------------+ + | :ref:`bool` | :ref:`loop` | ``false`` | + +---------------------------------------+--------------------------------------------------------------------------+---------------+ | :ref:`bool` | :ref:`paused` | ``false`` | +---------------------------------------+--------------------------------------------------------------------------+---------------+ | :ref:`VideoStream` | :ref:`stream` | | @@ -65,6 +67,8 @@ Methods .. table:: :widths: auto + +-----------------------------------+------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_stream_length` **(** **)** |const| | +-----------------------------------+------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_stream_name` **(** **)** |const| | +-----------------------------------+------------------------------------------------------------------------------------------------+ @@ -188,6 +192,23 @@ If ``true``, the video scales to the control size. Otherwise, the control minimu ---- +.. _class_VideoStreamPlayer_property_loop: + +.. rst-class:: classref-property + +:ref:`bool` **loop** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_loop** **(** :ref:`bool` value **)** +- :ref:`bool` **has_loop** **(** **)** + +If ``true``, the video restarts when it reaches its end. + +.. rst-class:: classref-item-separator + +---- + .. _class_VideoStreamPlayer_property_paused: .. rst-class:: classref-property @@ -280,6 +301,20 @@ Audio volume in dB. Method Descriptions ------------------- +.. _class_VideoStreamPlayer_method_get_stream_length: + +.. rst-class:: classref-method + +:ref:`float` **get_stream_length** **(** **)** |const| + +The length of the current stream, in seconds. + +\ **Note:** For :ref:`VideoStreamTheora` streams (the built-in format supported by Godot), this value will always be zero, as getting the stream length is not implemented yet. The feature may be supported by video formats implemented by a GDExtension add-on. + +.. rst-class:: classref-item-separator + +---- + .. _class_VideoStreamPlayer_method_get_stream_name: .. rst-class:: classref-method diff --git a/classes/class_window.rst b/classes/class_window.rst index 355ed743b7e..3c12ec2bcaa 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -249,31 +249,33 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`title_color` | ``Color(0.875, 0.875, 0.875, 1)`` | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Color` | :ref:`title_outline_modulate` | ``Color(1, 1, 1, 1)`` | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`close_h_offset` | ``18`` | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`close_v_offset` | ``24`` | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`resize_margin` | ``4`` | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`title_height` | ``36`` | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`title_outline_size` | ``0`` | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Font` | :ref:`title_font` | | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`title_font_size` | | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Texture2D` | :ref:`close` | | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Texture2D` | :ref:`close_pressed` | | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`StyleBox` | :ref:`embedded_border` | | - +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+ + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`title_color` | ``Color(0.875, 0.875, 0.875, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`title_outline_modulate` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`close_h_offset` | ``18`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`close_v_offset` | ``24`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`resize_margin` | ``4`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`title_height` | ``36`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`title_outline_size` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Font` | :ref:`title_font` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`title_font_size` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`close` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`close_pressed` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`embedded_border` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`embedded_unfocused_border` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+ .. rst-class:: classref-section-separator @@ -2440,6 +2442,18 @@ The background style used when the **Window** is embedded. Note that this is dra \ **Note:** The content background will not be visible unless :ref:`transparent` is enabled. +.. rst-class:: classref-item-separator + +---- + +.. _class_Window_theme_style_embedded_unfocused_border: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **embedded_unfocused_border** + +The background style used when the **Window** is embedded and unfocused. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/index.rst b/classes/index.rst index 2e5296d1878..63a6fd92c16 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -830,6 +830,21 @@ Other objects class_resourceformatloader class_resourceformatsaver class_resourceimporter + class_resourceimporterbitmap + class_resourceimporterbmfont + class_resourceimportercsvtranslation + class_resourceimporterdynamicfont + class_resourceimporterimage + class_resourceimporterimagefont + class_resourceimporterlayeredtexture + class_resourceimportermp3 + class_resourceimporterobj + class_resourceimporteroggvorbis + class_resourceimporterscene + class_resourceimportershaderfile + class_resourceimportertexture + class_resourceimportertextureatlas + class_resourceimporterwav class_resourceloader class_resourcesaver class_resourceuid