Fix miscellaneous oddities around the class reference (part 6) #107536
+123
−123
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mickeon
force-pushed
the
documentation-miscellaneous-oddities-part-6
branch
from
765a896 to
5735913
Compare
Mickeon
commented
Jun 14, 2025
| @@ -31,7 +31,7 @@ | |||
| </methods> | |||
| <members> | |||
| <member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance3D.ShadowCastingSetting" default="1"> | |||
| The selected shadow casting flag. | |||
| The mode used to cast shadows from this instance. | |||
There was a problem hiding this comment.
Alternative which I am genuinely not sure.
Suggested change
| The mode used to cast shadows from this instance. | |
| The way in which this instance casts shadows. |
Comment on lines
294
to
+296
| <param index="0" name="file" type="String" /> | ||
| <description> | ||
| Returns file size in bytes, or [code]-1[/code] on error. | ||
| Returns the size of the file at the given path, in bytes, or [code]-1[/code] on error. |
There was a problem hiding this comment.
Yes, file is actually a file path. Put a pin on this.
There was a problem hiding this comment.
Maybe it should be changed to path, renaming argument is not breaking change.
| @@ -3745,7 +3745,7 @@ | |||
| <param index="7" name="layered_type" type="int" enum="RenderingServer.TextureLayeredType" default="0" /> | |||
| <description> | |||
| Creates a texture based on a native handle that was created outside of Godot's renderer. | |||
| [b]Note:[/b] If using only the rendering device renderer, it's recommend to use [method RenderingDevice.texture_create_from_extension] together with [method RenderingServer.texture_rd_create], rather than this method. It will give you much more control over the texture's format and usage. | |||
| [b]Note:[/b] If using only the rendering device renderer, it's recommend to use [method RenderingDevice.texture_create_from_extension] together with [method RenderingServer.texture_rd_create], rather than this method. This way, the texture's format and usage can be controlled more effectively. | |||
There was a problem hiding this comment.
The reason this was done is because the previous sentence is indirect (no "you"). But, alternatively:
Suggested change
| [b]Note:[/b] If using only the rendering device renderer, it's recommend to use [method RenderingDevice.texture_create_from_extension] together with [method RenderingServer.texture_rd_create], rather than this method. This way, the texture's format and usage can be controlled more effectively. | |
| [b]Note:[/b] If using only the rendering device renderer, it's recommend to use [method RenderingDevice.texture_create_from_extension] together with [method RenderingServer.texture_rd_create], rather than this method. You will be able to control the texture's format and usage more effectively. |
| @@ -3410,7 +3410,7 @@ | |||
| The ratio of [WorkerThreadPool]'s threads that will be reserved for low-priority tasks. For example, if 10 threads are available and this value is set to [code]0.3[/code], 3 of the worker threads will be reserved for low-priority tasks. The actual value won't exceed the number of CPU cores minus one, and if possible, at least one worker thread will be dedicated to low-priority tasks. | |||
| </member> | |||
| <member name="threading/worker_pool/max_threads" type="int" setter="" getter="" default="-1"> | |||
| Maximum number of threads to be used by [WorkerThreadPool]. Value of [code]-1[/code] means [code]1[/code] on Web, or a number of [i]logical[/i] CPU cores available on other platforms (see [method OS.get_processor_count]). | |||
| Maximum number of threads to be used by [WorkerThreadPool]. On Web, a value of [code]-1[/code] means [code]1[/code]. On other platforms, it means all [i]logical[/i] CPU cores available (see [method OS.get_processor_count]). | |||
There was a problem hiding this comment.
Something about this still bothers me.
| @@ -3356,7 +3356,7 @@ | |||
| If [code]true[/code], the texture importer will import lossless textures using the PNG format. Otherwise, it will default to using WebP. | |||
| </member> | |||
| <member name="rendering/textures/vram_compression/cache_gpu_compressor" type="bool" setter="" getter="" default="true"> | |||
| If [code]true[/code], the GPU texture compressor will cache the local RenderingDevice and its resources (shaders and pipelines), allowing for faster subsequent imports at a memory cost. | |||
| If [code]true[/code], the GPU texture compressor will cache the local RenderingDevice and its resources (shaders and pipelines), making subsequent imports faster at the cost of increased memory usage. | |||
There was a problem hiding this comment.
Maybe this was fine before? It was very succinct, maybe too much.
| @@ -522,7 +522,7 @@ | |||
| A signal can only be connected once to the same [Callable]. If the signal is already connected, this method returns [constant ERR_INVALID_PARAMETER] and generates an error, unless the signal is connected with [constant CONNECT_REFERENCE_COUNTED]. To prevent this, use [method is_connected] first to check for existing connections. | |||
| [b]Note:[/b] If the [param callable]'s object is freed, the connection will be lost. | |||
| [b]Note:[/b] In GDScript, it is generally recommended to connect signals with [method Signal.connect] instead. | |||
| [b]Note:[/b] This operation (and all other signal related operations) is thread-safe. | |||
| [b]Note:[/b] This method, and all other signal-related methods, are thread-safe. | |||
There was a problem hiding this comment.
I genuinely don't think this note needs to exist, especially specifically only in Object.connect, but I digress.
Mickeon
force-pushed
the
documentation-miscellaneous-oddities-part-6
branch
2 times, most recently
from
c82c970 to
216435e
Compare
bruvzg
reviewed
Jun 15, 2025
Comment on lines
294
to
+296
| <param index="0" name="file" type="String" /> | ||
| <description> | ||
| Returns file size in bytes, or [code]-1[/code] on error. | ||
| Returns the size of the file at the given path, in bytes, or [code]-1[/code] on error. |
There was a problem hiding this comment.
Maybe it should be changed to path, renaming argument is not breaking change.
Mickeon
force-pushed
the
documentation-miscellaneous-oddities-part-6
branch
from
216435e to
6df0ff0
Compare
This was referenced Jun 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continuation of #107143
This PR addressed yet yet another huge chunk of class reference oddities I remembered to note down for later while localizing the class reference. Some of these are clear typos, some are inconsistencies, some are just awkward.
Of particular note:
languageeverywherealpha channel" punnetwork/connection/network_modeto be somewhat less awkwardmove_to_centeris_pixel_opaqueget_dataandget_doubletab_close_pressedkeep_compressed_buffersizedescription aroundoversamplingpropertiescast_shadowto be more meaningfulxr/openxr/foveation_levelget_script_signal_listadd_user_signal[code]tags to TextServer'sstring_to_upper& similargetmethodsscreen_get_pixelclaiming it returns a whole screenshot and literally the entire [Color] typehorizontal_alignmentproperties, leading to duplicate translation stringsFor some of the descriptions affected, additional tweaks have been made to justify a whole translation string change.