diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index ebb7762634a..28ab0c65f35 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -3615,7 +3615,7 @@ Hints that a :ref:`Color` property should be edited without affecti :ref:`PropertyHint` **PROPERTY_HINT_OBJECT_ID** = ``22`` - +Hints that the property's value is an object encoded as object ID, with its type specified in the hint string. Used by the debugger. .. _class_@GlobalScope_constant_PROPERTY_HINT_TYPE_STRING: @@ -3698,7 +3698,7 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE** = ``24`` - +*Deprecated.* This hint is not used anywhere and will be removed in the future. .. _class_@GlobalScope_constant_PROPERTY_HINT_OBJECT_TOO_BIG: @@ -3706,7 +3706,7 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_OBJECT_TOO_BIG** = ``25`` - +Hints that an object is too big to be sent via the debugger. .. _class_@GlobalScope_constant_PROPERTY_HINT_NODE_PATH_VALID_TYPES: @@ -3714,7 +3714,7 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_NODE_PATH_VALID_TYPES** = ``26`` - +Hints that the hint string specifies valid node types for property of type :ref:`NodePath`. .. _class_@GlobalScope_constant_PROPERTY_HINT_SAVE_FILE: @@ -3722,7 +3722,7 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_SAVE_FILE** = ``27`` - +Hints that a :ref:`String` property is a path to a file. Editing it will show a file dialog for picking the path for the file to be saved at. The dialog has access to the project's directory. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``. See also :ref:`FileDialog.filters`. .. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_SAVE_FILE: @@ -3730,7 +3730,7 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_GLOBAL_SAVE_FILE** = ``28`` - +Hints that a :ref:`String` property is a path to a file. Editing it will show a file dialog for picking the path for the file to be saved at. The dialog has access to the entire filesystem. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``. See also :ref:`FileDialog.filters`. .. _class_@GlobalScope_constant_PROPERTY_HINT_INT_IS_OBJECTID: @@ -3738,7 +3738,9 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_INT_IS_OBJECTID** = ``29`` +Hints that an :ref:`int` property is an object ID. +\ *Deprecated.* This hint is not used anywhere and will be removed in the future. .. _class_@GlobalScope_constant_PROPERTY_HINT_INT_IS_POINTER: @@ -3746,7 +3748,7 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_INT_IS_POINTER** = ``30`` - +Hints that an :ref:`int` property is a pointer. Used by GDExtension. .. _class_@GlobalScope_constant_PROPERTY_HINT_ARRAY_TYPE: @@ -3754,7 +3756,7 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_ARRAY_TYPE** = ``31`` - +Hints that a property is an :ref:`Array` with the stored type specified in the hint string. .. _class_@GlobalScope_constant_PROPERTY_HINT_LOCALE_ID: @@ -3778,7 +3780,7 @@ Hints that a dictionary property is string translation map. Dictionary keys are :ref:`PropertyHint` **PROPERTY_HINT_NODE_TYPE** = ``34`` - +Hints that a property is an instance of a :ref:`Node`-derived type, optionally specified via the hint string (e.g. ``"Node2D"``). Editing it will show a dialog for picking a node from the scene. .. _class_@GlobalScope_constant_PROPERTY_HINT_HIDE_QUATERNION_EDIT: @@ -3892,7 +3894,7 @@ Used to group properties together in the editor in a subgroup (under a group). S :ref:`PropertyUsageFlags` **PROPERTY_USAGE_CLASS_IS_BITFIELD** = ``512`` - +The property is a bitfield, i.e. it contains multiple flags represented as bits. .. _class_@GlobalScope_constant_PROPERTY_USAGE_NO_INSTANCE_STATE: @@ -3924,7 +3926,7 @@ The property is a script variable which should be serialized and saved in the sc :ref:`PropertyUsageFlags` **PROPERTY_USAGE_STORE_IF_NULL** = ``8192`` - +The property value of type :ref:`Object` will be stored even if its value is ``null``. .. _class_@GlobalScope_constant_PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED: @@ -3932,7 +3934,7 @@ The property is a script variable which should be serialized and saved in the sc :ref:`PropertyUsageFlags` **PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED** = ``16384`` - +If this property is modified, all inspector fields will be refreshed. .. _class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_DEFAULT_VALUE: @@ -3940,7 +3942,9 @@ The property is a script variable which should be serialized and saved in the sc :ref:`PropertyUsageFlags` **PROPERTY_USAGE_SCRIPT_DEFAULT_VALUE** = ``32768`` +Signifies a default value from a placeholder script instance. +\ *Deprecated.* This hint is not used anywhere and will be removed in the future. .. _class_@GlobalScope_constant_PROPERTY_USAGE_CLASS_IS_ENUM: @@ -3948,7 +3952,7 @@ The property is a script variable which should be serialized and saved in the sc :ref:`PropertyUsageFlags` **PROPERTY_USAGE_CLASS_IS_ENUM** = ``65536`` - +The property is an enum, i.e. it only takes named integer constants from its associated enumeration. .. _class_@GlobalScope_constant_PROPERTY_USAGE_NIL_IS_VARIANT: @@ -3956,7 +3960,7 @@ The property is a script variable which should be serialized and saved in the sc :ref:`PropertyUsageFlags` **PROPERTY_USAGE_NIL_IS_VARIANT** = ``131072`` - +If property has ``nil`` as default value, its type will be :ref:`Variant`. .. _class_@GlobalScope_constant_PROPERTY_USAGE_ARRAY: @@ -3996,7 +4000,7 @@ The property is only shown in the editor if modern renderers are supported (the :ref:`PropertyUsageFlags` **PROPERTY_USAGE_NODE_PATH_FROM_SCENE_ROOT** = ``4194304`` - +The :ref:`NodePath` property will always be relative to the scene's root. Mostly useful for local resources. .. _class_@GlobalScope_constant_PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT: @@ -4004,7 +4008,7 @@ The property is only shown in the editor if modern renderers are supported (the :ref:`PropertyUsageFlags` **PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT** = ``8388608`` - +Use when a resource is created on the fly, i.e. the getter will always return a different instance. :ref:`ResourceSaver` needs this information to properly save such resources. .. _class_@GlobalScope_constant_PROPERTY_USAGE_KEYING_INCREMENTS: @@ -4012,7 +4016,7 @@ The property is only shown in the editor if modern renderers are supported (the :ref:`PropertyUsageFlags` **PROPERTY_USAGE_KEYING_INCREMENTS** = ``16777216`` - +Inserting an animation key frame of this property will automatically increment the value, allowing to easily keyframe multiple values in a row. .. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFERRED_SET_RESOURCE: @@ -4020,7 +4024,9 @@ The property is only shown in the editor if modern renderers are supported (the :ref:`PropertyUsageFlags` **PROPERTY_USAGE_DEFERRED_SET_RESOURCE** = ``33554432`` +When loading, the resource for this property can be set at the end of loading. +\ *Deprecated.* This hint is not used anywhere and will be removed in the future. .. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR_INSTANTIATE_OBJECT: @@ -4028,7 +4034,7 @@ The property is only shown in the editor if modern renderers are supported (the :ref:`PropertyUsageFlags` **PROPERTY_USAGE_EDITOR_INSTANTIATE_OBJECT** = ``67108864`` - +When this property is a :ref:`Resource` and base object is a :ref:`Node`, a resource instance will be automatically created whenever the node is created in the editor. .. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR_BASIC_SETTING: @@ -4036,7 +4042,7 @@ The property is only shown in the editor if modern renderers are supported (the :ref:`PropertyUsageFlags` **PROPERTY_USAGE_EDITOR_BASIC_SETTING** = ``134217728`` - +The property is considered a basic setting and will appear even when advanced mode is disabled. Used for project settings. .. _class_@GlobalScope_constant_PROPERTY_USAGE_READ_ONLY: @@ -7347,7 +7353,7 @@ Prints: :ref:`Variant` **weakref** **(** :ref:`Variant` obj **)** -Returns a weak reference to an object, or ``null`` if ``obj`` is invalid. +Returns a :ref:`WeakRef` instance holding a weak reference to ``obj``. Returns an empty :ref:`WeakRef` instance if ``obj`` is ``null``. Prints an error and returns ``null`` if ``obj`` is neither :ref:`Object`-derived nor ``null``. A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 6ac49232c7c..a8ddb0a83fb 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -21,6 +21,13 @@ Description The AudioStreamOggVorbis class is a specialized :ref:`AudioStream` for handling Ogg Vorbis file formats. It offers functionality for loading and playing back Ogg Vorbis files, as well as managing looping and other playback properties. This class is part of the audio stream system, which also supports WAV files through the :ref:`AudioStreamWAV` class. +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_audiostreamwav.rst b/classes/class_audiostreamwav.rst index c5e0d123399..1e72eeb5eb8 100644 --- a/classes/class_audiostreamwav.rst +++ b/classes/class_audiostreamwav.rst @@ -23,6 +23,13 @@ AudioStreamWAV stores sound samples loaded from WAV files. To play the stored so This class can also be used to store dynamically-generated PCM audio data. See also :ref:`AudioStreamGenerator` for procedural audio generation. +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 3dc97523b6c..87857581595 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -246,7 +246,7 @@ Particles are drawn in the order emitted. :ref:`DrawOrder` **DRAW_ORDER_LIFETIME** = ``1`` -Particles are drawn in order of remaining lifetime. +Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front. .. rst-class:: classref-item-separator diff --git a/classes/class_cpuparticles3d.rst b/classes/class_cpuparticles3d.rst index a166efabf66..218c57d0e9b 100644 --- a/classes/class_cpuparticles3d.rst +++ b/classes/class_cpuparticles3d.rst @@ -262,7 +262,7 @@ Particles are drawn in the order emitted. :ref:`DrawOrder` **DRAW_ORDER_LIFETIME** = ``1`` -Particles are drawn in order of remaining lifetime. +Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front. .. _class_CPUParticles3D_constant_DRAW_ORDER_VIEW_DEPTH: diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index bdcfbff1b83..2e00a7bc5b5 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -69,6 +69,8 @@ Tutorials - :doc:`File system <../tutorials/scripting/filesystem>` +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `3D Voxel Demo `__ .. rst-class:: classref-reftable-group diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index ea93c40942e..e808a1206b4 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -56,6 +56,13 @@ Supported font formats: +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gltfaccessor.rst b/classes/class_gltfaccessor.rst index 4bf79eebd9c..30fd10eeb01 100644 --- a/classes/class_gltfaccessor.rst +++ b/classes/class_gltfaccessor.rst @@ -16,6 +16,13 @@ GLTFAccessor There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gltfanimation.rst b/classes/class_gltfanimation.rst index cf88430f2a4..7959e1f2a35 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -16,6 +16,13 @@ GLTFAnimation There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gltfbufferview.rst b/classes/class_gltfbufferview.rst index 054fd1f9da0..44a5d4b03fc 100644 --- a/classes/class_gltfbufferview.rst +++ b/classes/class_gltfbufferview.rst @@ -16,6 +16,13 @@ GLTFBufferView There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gltfcamera.rst b/classes/class_gltfcamera.rst index dfd15f1ca9a..ec53168547f 100644 --- a/classes/class_gltfcamera.rst +++ b/classes/class_gltfcamera.rst @@ -26,6 +26,8 @@ Represents a camera as defined by the base GLTF spec. Tutorials --------- +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `GLTF camera detailed specification `__ - `GLTF camera spec and example file `__ diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index eea1ac1cb9b..0ee16d8009e 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -30,6 +30,8 @@ GLTFDocument can be extended with arbitrary functionality by extending the :ref: Tutorials --------- +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `glTF 'What the duck?' guide `__ - `Khronos glTF specification `__ diff --git a/classes/class_gltfdocumentextension.rst b/classes/class_gltfdocumentextension.rst index 2d677a74658..b37cdc84df6 100644 --- a/classes/class_gltfdocumentextension.rst +++ b/classes/class_gltfdocumentextension.rst @@ -27,6 +27,13 @@ To use, make a new class extending GLTFDocumentExtension, override any methods y \ **Note:** Like GLTFDocument itself, all GLTFDocumentExtension classes must be stateless in order to function properly. If you need to store data, use the ``set_additional_data`` and ``get_additional_data`` methods in :ref:`GLTFState` or :ref:`GLTFNode`. +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Methods diff --git a/classes/class_gltfdocumentextensionconvertimportermesh.rst b/classes/class_gltfdocumentextensionconvertimportermesh.rst index 2af7845a342..08e01476bf6 100644 --- a/classes/class_gltfdocumentextensionconvertimportermesh.rst +++ b/classes/class_gltfdocumentextensionconvertimportermesh.rst @@ -16,6 +16,13 @@ GLTFDocumentExtensionConvertImporterMesh There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. |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_gltflight.rst b/classes/class_gltflight.rst index 20805938cb0..a8bed0c99a0 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -26,6 +26,8 @@ Represents a light as defined by the ``KHR_lights_punctual`` GLTF extension. Tutorials --------- +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `KHR_lights_punctual GLTF extension spec `__ .. rst-class:: classref-reftable-group diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index 1aa58a6267a..5829f630c11 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -16,6 +16,13 @@ GLTFMesh There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index 2a6dde37f50..396bb8e18b8 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -28,6 +28,8 @@ GLTF nodes generally exist inside of :ref:`GLTFState` which rep Tutorials --------- +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `GLTF scene and node spec `__ .. rst-class:: classref-reftable-group diff --git a/classes/class_gltfphysicsbody.rst b/classes/class_gltfphysicsbody.rst index 51d8937dd8a..65e4847fa3a 100644 --- a/classes/class_gltfphysicsbody.rst +++ b/classes/class_gltfphysicsbody.rst @@ -26,6 +26,8 @@ Represents a physics body as defined by the ``OMI_physics_body`` GLTF extension. Tutorials --------- +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `OMI_physics_body GLTF extension `__ .. rst-class:: classref-reftable-group diff --git a/classes/class_gltfphysicsshape.rst b/classes/class_gltfphysicsshape.rst index 5c9a8a08a5a..7756f5ff7d2 100644 --- a/classes/class_gltfphysicsshape.rst +++ b/classes/class_gltfphysicsshape.rst @@ -26,6 +26,8 @@ Represents a physics shape as defined by the ``OMI_collider`` GLTF extension. Th Tutorials --------- +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `OMI_collider GLTF extension `__ .. rst-class:: classref-reftable-group diff --git a/classes/class_gltfskeleton.rst b/classes/class_gltfskeleton.rst index 1aa46311175..f864657c3e8 100644 --- a/classes/class_gltfskeleton.rst +++ b/classes/class_gltfskeleton.rst @@ -16,6 +16,13 @@ GLTFSkeleton There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index 868b66c4b0f..78424c80d62 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -16,6 +16,13 @@ GLTFSkin There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gltfspecgloss.rst b/classes/class_gltfspecgloss.rst index 9afdb215cb8..4b632f34899 100644 --- a/classes/class_gltfspecgloss.rst +++ b/classes/class_gltfspecgloss.rst @@ -26,6 +26,8 @@ KHR_materials_pbrSpecularGlossiness is an archived GLTF extension. This means th Tutorials --------- +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `KHR_materials_pbrSpecularGlossiness GLTF extension spec `__ .. rst-class:: classref-reftable-group diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index 30797df50f2..d2f103e788f 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -28,6 +28,8 @@ GLTFState can be populated by :ref:`GLTFDocument` reading a Tutorials --------- +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + - `GLTF asset header schema `__ .. rst-class:: classref-reftable-group diff --git a/classes/class_gltftexture.rst b/classes/class_gltftexture.rst index d33b2264fa5..ce77f726ff5 100644 --- a/classes/class_gltftexture.rst +++ b/classes/class_gltftexture.rst @@ -16,6 +16,13 @@ GLTFTexture There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gltftexturesampler.rst b/classes/class_gltftexturesampler.rst index 9eebd5254e9..9808ea3140d 100644 --- a/classes/class_gltftexturesampler.rst +++ b/classes/class_gltftexturesampler.rst @@ -21,6 +21,13 @@ Description Represents a texture sampler as defined by the base GLTF spec. Texture samplers in GLTF specify how to sample data from the texture's base image, when rendering the texture on an object. +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index ce2af27c363..541020cbb53 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -160,7 +160,7 @@ Particles are drawn in the order emitted. :ref:`DrawOrder` **DRAW_ORDER_LIFETIME** = ``1`` -Particles are drawn in order of remaining lifetime. +Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front. .. _class_GPUParticles2D_constant_DRAW_ORDER_REVERSE_LIFETIME: @@ -168,7 +168,7 @@ Particles are drawn in order of remaining lifetime. :ref:`DrawOrder` **DRAW_ORDER_REVERSE_LIFETIME** = ``2`` - +Particles are drawn in reverse order of remaining lifetime. In other words, the particle with the lowest lifetime is drawn at the front. .. rst-class:: classref-item-separator diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 2079c7ed48b..1266893fc5e 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -170,7 +170,7 @@ Particles are drawn in the order emitted. :ref:`DrawOrder` **DRAW_ORDER_LIFETIME** = ``1`` -Particles are drawn in order of remaining lifetime. +Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front. .. _class_GPUParticles3D_constant_DRAW_ORDER_REVERSE_LIFETIME: @@ -178,7 +178,7 @@ Particles are drawn in order of remaining lifetime. :ref:`DrawOrder` **DRAW_ORDER_REVERSE_LIFETIME** = ``2`` - +Particles are drawn in reverse order of remaining lifetime. In other words, the particle with the lowest lifetime is drawn at the front. .. _class_GPUParticles3D_constant_DRAW_ORDER_VIEW_DEPTH: diff --git a/classes/class_image.rst b/classes/class_image.rst index 8a1e4e1baa0..68a47239f37 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -32,6 +32,8 @@ Tutorials - :doc:`Importing images <../tutorials/assets_pipeline/importing_images>` +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties @@ -1162,9 +1164,9 @@ Flips the image vertically. :ref:`Error` **generate_mipmaps** **(** :ref:`bool` renormalize=false **)** -Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is ``0``. Enabling ``renormalize`` when generating mipmaps for normal textures will make sure all resulting vector values are normalized. +Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is ``0``. Enabling ``renormalize`` when generating mipmaps for normal map textures will make sure all resulting vector values are normalized. -It is possible to check if the image has mipmaps by calling :ref:`has_mipmaps` or :ref:`get_mipmap_count`. +It is possible to check if the image has mipmaps by calling :ref:`has_mipmaps` or :ref:`get_mipmap_count`. Calling :ref:`generate_mipmaps` on an image that already has mipmaps will replace existing mipmaps in the image. .. rst-class:: classref-item-separator @@ -1380,6 +1382,8 @@ Loads an image from the binary contents of a BMP file. \ **Note:** Godot's BMP module doesn't support 16-bit per pixel images. Only 1-bit, 4-bit, 8-bit, 24-bit, and 32-bit per pixel images are supported. +\ **Note:** This method is only available in engine builds with the BMP module enabled. By default, the BMP module is enabled, but it can be disabled at build-time using the ``module_bmp_enabled=no`` SCons option. + .. rst-class:: classref-item-separator ---- @@ -1414,7 +1418,11 @@ Loads an image from the binary contents of a JPEG file. :ref:`Error` **load_ktx_from_buffer** **(** :ref:`PackedByteArray` buffer **)** -Loads an image from the binary contents of a KTX file. +Loads an image from the binary contents of a `KTX `__ file. Unlike most image formats, KTX can store VRAM-compressed data and embed mipmaps. + +\ **Note:** Godot's libktx implementation only supports 2D images. Cubemaps, texture arrays, and de-padding are not supported. + +\ **Note:** This method is only available in engine builds with the KTX module enabled. By default, the KTX module is enabled, but it can be disabled at build-time using the ``module_ktx_enabled=no`` SCons option. .. rst-class:: classref-item-separator @@ -1470,6 +1478,8 @@ Loads an image from the string contents of a SVG file (**.svg**). Loads an image from the binary contents of a TGA file. +\ **Note:** This method is only available in engine builds with the TGA module enabled. By default, the TGA module is enabled, but it can be disabled at build-time using the ``module_tga_enabled=no`` SCons option. + .. rst-class:: classref-item-separator ---- @@ -1504,7 +1514,7 @@ Converts the image's data to represent coordinates on a 3D plane. This is used w void **premultiply_alpha** **(** **)** -Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. +Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. See also :ref:`CanvasItemMaterial.blend_mode`. .. rst-class:: classref-item-separator @@ -1656,7 +1666,9 @@ Saves the image as a PNG file to a byte array. :ref:`Error` **save_webp** **(** :ref:`String` path, :ref:`bool` lossy=false, :ref:`float` quality=0.75 **)** |const| -Saves the image as a WebP (Web Picture) file to the file at ``path``. By default it will save lossless. If ``lossy`` is true, the image will be saved lossy, using the ``quality`` setting between 0.0 and 1.0 (inclusive). +Saves the image as a WebP (Web Picture) file to the file at ``path``. By default it will save lossless. If ``lossy`` is true, the image will be saved lossy, using the ``quality`` setting between 0.0 and 1.0 (inclusive). Lossless WebP offers more efficient compression than PNG. + +\ **Note:** The WebP format is limited to a size of 16383×16383 pixels, while PNG can save larger images. .. rst-class:: classref-item-separator @@ -1668,7 +1680,9 @@ Saves the image as a WebP (Web Picture) file to the file at ``path``. By default :ref:`PackedByteArray` **save_webp_to_buffer** **(** :ref:`bool` lossy=false, :ref:`float` quality=0.75 **)** |const| -Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If ``lossy`` is true, the image will be saved lossy, using the ``quality`` setting between 0.0 and 1.0 (inclusive). +Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If ``lossy`` is true, the image will be saved lossy, using the ``quality`` setting between 0.0 and 1.0 (inclusive). Lossless WebP offers more efficient compression than PNG. + +\ **Note:** The WebP format is limited to a size of 16383×16383 pixels, while PNG can save larger images. .. rst-class:: classref-item-separator @@ -1766,7 +1780,7 @@ This is the same as :ref:`set_pixel`, but with a : void **shrink_x2** **(** **)** -Shrinks the image by a factor of 2. +Shrinks the image by a factor of 2 on each axis (this divides the pixel count by 4). .. rst-class:: classref-item-separator diff --git a/classes/class_input.rst b/classes/class_input.rst index 15dd2ead06b..b36ec486987 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -742,6 +742,8 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: \ **Note:** Due to keyboard ghosting, :ref:`is_action_just_pressed` may return ``false`` even if one of the action's keys is pressed. See `Input examples <../tutorials/inputs/input_examples.html#keyboard-events>`__ in the documentation for more information. +\ **Note:** During input handling (e.g. :ref:`Node._input`), use :ref:`InputEvent.is_action_pressed` instead to query the action state of the current event. + .. rst-class:: classref-item-separator ---- @@ -758,6 +760,8 @@ Returns ``true`` when the user *stops* pressing the action event in the current If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. +\ **Note:** During input handling (e.g. :ref:`Node._input`), use :ref:`InputEvent.is_action_released` instead to query the action state of the current event. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_node.rst b/classes/class_node.rst index 7b803d6d6d5..e95fc85feca 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1935,7 +1935,7 @@ Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlac :ref:`SceneTree` **get_tree** **(** **)** |const| -Returns the :ref:`SceneTree` that contains this node. +Returns the :ref:`SceneTree` that contains this node. Returns ``null`` and prints an error if this node is not inside the scene tree. See also :ref:`is_inside_tree`. .. rst-class:: classref-item-separator diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index dbc9c865af1..6236f903fb1 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1964,7 +1964,9 @@ Changes to this setting will only be applied upon restarting the application. :ref:`int` **application/run/frame_delay_msec** = ``0`` -Forces a delay between frames in the main loop (in milliseconds). This may be useful if you plan to disable vertical synchronization. +Forces a *constant* delay between frames in the main loop (in milliseconds). In most situations, :ref:`application/run/max_fps` should be preferred as an FPS limiter as it's more precise. + +This setting can be overridden using the ``--frame-delay `` command line argument. .. rst-class:: classref-item-separator diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 95ae8d6544e..ff22d1cb039 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -25,6 +25,8 @@ Base class for any object that keeps a reference count. :ref:`Resource` types, **RefCounted**\ s keep an internal reference counter so that they are automatically released when no longer in use, and only then. **RefCounted**\ s therefore do not need to be freed manually with :ref:`Object.free`. +\ **RefCounted** instances caught in a cyclic reference will **not** be freed automatically. For example, if a node holds a reference to instance ``A``, which directly or indirectly holds a reference back to ``A``, ``A``'s reference count will be 2. Destruction of the node will leave ``A`` dangling with a reference count of 1, and there will be a memory leak. To prevent this, one of the references in the cycle can be made weak with :ref:`@GlobalScope.weakref`. + In the vast majority of use cases, instantiating and using **RefCounted**-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused. \ **Note:** In C#, reference-counted objects will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free reference-counted objects that are no longer in use. This means that unused ones will linger on for a while before being removed. diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 54fec469c18..dbe725f0eb9 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -2532,7 +2532,7 @@ Draw particles in the order that they appear in the particles array. :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1`` -Sort particles based on their lifetime. +Sort particles based on their lifetime. In other words, the particle with the highest lifetime is drawn at the front. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME: @@ -2540,7 +2540,7 @@ Sort particles based on their lifetime. :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2`` - +Sort particles based on the inverse of their lifetime. In other words, the particle with the lowest lifetime is drawn at the front. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH: diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index a20a7bb2b65..0b49aa2bbaa 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -493,9 +493,7 @@ Returns the pose transform of the specified bone. :ref:`Vector3` **get_bone_pose_position** **(** :ref:`int` bone_idx **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the pose position of the bone at ``bone_idx``. The returned :ref:`Vector3` is in the local coordinate space of the **Skeleton3D** node. .. rst-class:: classref-item-separator @@ -507,9 +505,7 @@ Returns the pose transform of the specified bone. :ref:`Quaternion` **get_bone_pose_rotation** **(** :ref:`int` bone_idx **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the pose rotation of the bone at ``bone_idx``. The returned :ref:`Quaternion` is local to the bone with respect to the rotation of any parent bones. .. rst-class:: classref-item-separator @@ -521,9 +517,7 @@ Returns the pose transform of the specified bone. :ref:`Vector3` **get_bone_pose_scale** **(** :ref:`int` bone_idx **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the pose scale of the bone at ``bone_idx``. .. rst-class:: classref-item-separator @@ -745,9 +739,7 @@ Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If void **set_bone_pose_position** **(** :ref:`int` bone_idx, :ref:`Vector3` position **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the pose position of the bone at ``bone_idx`` to ``position``. ``position`` is a :ref:`Vector3` describing a position local to the **Skeleton3D** node. .. rst-class:: classref-item-separator @@ -759,9 +751,7 @@ void **set_bone_pose_position** **(** :ref:`int` bone_idx, :ref:`Vect void **set_bone_pose_rotation** **(** :ref:`int` bone_idx, :ref:`Quaternion` rotation **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the pose rotation of the bone at ``bone_idx`` to ``rotation``. ``rotation`` is a :ref:`Quaternion` describing a rotation in the bone's local coordinate space with respect to the rotation of any parent bones. .. rst-class:: classref-item-separator @@ -773,9 +763,7 @@ void **set_bone_pose_rotation** **(** :ref:`int` bone_idx, :ref:`Quat void **set_bone_pose_scale** **(** :ref:`int` bone_idx, :ref:`Vector3` scale **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the pose scale of the bone at ``bone_idx`` to ``scale``. .. rst-class:: classref-item-separator diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 796b9d242dc..0ed6f5ef17e 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -1735,7 +1735,7 @@ Returns number of faces in the TrueType / OpenType collection. :ref:`int` **font_get_face_index** **(** :ref:`RID` font_rid **)** |const| -Recturns an active face index in the TrueType / OpenType collection. +Returns an active face index in the TrueType / OpenType collection. .. rst-class:: classref-item-separator @@ -1759,7 +1759,7 @@ Returns bitmap font fixed size. :ref:`FixedSizeScaleMode` **font_get_fixed_size_scale_mode** **(** :ref:`RID` font_rid **)** |const| -Returned bitmap font scaling mode. +Returns bitmap font scaling mode. .. rst-class:: classref-item-separator diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index abe3c5a8da7..f024deadd14 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -30,6 +30,8 @@ Tutorials - :doc:`Playing videos <../tutorials/animation/playing_videos>` +- :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` + .. rst-class:: classref-reftable-group Properties diff --git a/classes/index.rst b/classes/index.rst index 75b918b1bcb..8731b60a2f8 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -1,4 +1,5 @@ :github_url: hide +:allow_comments: False .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources.