[4.3] Cherry-picks for the 4.3 (4.3.1) branch - 1st docs batch #925

Spartan322 · 2025-01-16T15:27:56Z

Documentation PR Range:

Clarify documentation for Geometry2D.line_intersects_line godotengine/godot#92001 - Document shader time rollover project setting godotengine/godot#95381
Clarify Timer.start() documentation to match the current behavior. godotengine/godot#95485 - Clarify that fog_aerial_perspective does not actually use sky color godotengine/godot#97842
Document non-resource file handling in FileAccess and ResourceLoader godotengine/godot#97906 - Fix a documentation typo in Control._drop_data() C#-example. godotengine/godot#97966
Fix documentation tip for network/debug/remote_host editor setting godotengine/godot#98282
Clarify TextEdit.is_caret_visible() behavior in the class reference godotengine/godot#98423
Improve documentation on @GlobalScope.PROPERTY_USAGE_SCRIPT_VARIABLE godotengine/godot#98478
Remove link to outdated CharFX example project godotengine/godot#98585 - Clarify in default texture repeat and filter docs that they only impact the built in texture godotengine/godot#98738
Docs: Update TileSet to reference TileMapLayer instead of TileMap godotengine/godot#98782 - Docs: Fix typo in AudioStreamSynchronized godotengine/godot#101459

(cherry picked from commit f7eb16c)

(cherry picked from commit 2c78284)

(cherry picked from commit 25ae74b)

(cherry picked from commit 336b9a2)

(cherry picked from commit d6ef881)

(cherry picked from commit bebf2e8)

…ffect (cherry picked from commit abe8d2c)

(cherry picked from commit b8f78b1)

… methods (cherry picked from commit 61ddf05)

This commit adds usage of the new (stringless) signal API. (cherry picked from commit a014705)

InputEventMouseMotion may fire when the mouse hasn't moved. Also, it generally won't fire when the mouse stops moving. This makes reliably detecting when the mouse isn't moving tricky. Update the docs for InputEventMouseMotion to capture these caveats and give guidance for the best way to detect lack of mouse movement. (cherry picked from commit 08dcbce)

The list now uses the Oxford comma. (cherry picked from commit 3e86f7b)

(cherry picked from commit 5b91040)

(cherry picked from commit 68799be)

- Mention the units used for Skew in the inspector and code. (cherry picked from commit c831376)

Minor grammar fix to make the sentences flow better. (cherry picked from commit 7e1bc00)

(cherry picked from commit 4612838)

…abel.get_character_bounds (cherry picked from commit c54e49c)

(cherry picked from commit 3a1160b)

(cherry picked from commit 212c340)

(cherry picked from commit 90aad07)

…e Tree editor setting (cherry picked from commit 540ac86)

- Shortcut: Clarifies how matches_event() method compares events - InputEvent: Clarifies is_match() method does not consider event states (cherry picked from commit 4f4fd1a)

(cherry picked from commit 3888695)

Co-authored-by: Rémi Verschelde <[email protected]> (cherry picked from commit 7b7164c)

(cherry picked from commit 21fb753)

`LightmapGI`'s documentation currently doesn't mention the fact it only bakes nodes under its parent. This can make the user think there is something wrong with their scene setup or 3D models, as it refuses to bake when the user's models / world isn't under the same parent as the `LightmapGI`. (cherry picked from commit 22caab0)

Some notes are ported from FileAccess (for example file_exist) Other notes were added when needed (for example when included on the non static version but not on the static version) Other entirely new notes were added as well when required for example when getting a list of directories or if a directory exist or not Clarified note at the top and made it more in line with the one found in file access Co-Authored-By: Micky <[email protected]> (cherry picked from commit 06bed7a)

The Z Index property is in CanvasItem since Godot 4.0, so it's shared among Node2D and Control. (cherry picked from commit d683ea4)

(cherry picked from commit 30a573e)

Tested with various ZIP files found on the web, with a single root folder or multiple files at its root. Co-authored-by: Raul Santos <[email protected]> (cherry picked from commit 4db9c11)

(cherry picked from commit e0b1300)

(cherry picked from commit e653f19)

All Packed classes that have the same paragraph will compare the currently viewed Packed array type with the equivalent typed Array but here the comparison was with the Int32 version instead of the Int64 version (cherry picked from commit 133cf62)

…y PackedArray classes (cherry picked from commit acf351f)

The range was broken because -1.0 was informed as being 1.0. (cherry picked from commit 84f4178)

(cherry picked from commit 3413c6c)

(cherry picked from commit 5d111e8)

The linked pull request was merged in Godot 4.3. (cherry picked from commit e499563)

…Mobile (cherry picked from commit 49ca40c)

This was a copy-paste error from the CollisionShape2D documentation. (cherry picked from commit 54a4a87)

…example Corrected improper string escaping in the OS.shell_open() Windows path example. Backslashes are now properly escaped to prevent string parsing errors. Also, added a new alternative example of how to mount a Windows path with OS.shell_open(). (cherry picked from commit 8a810dd)

- Add Dynamic TileMap Layers demo link as well. (cherry picked from commit 5bda507)

(cherry picked from commit 1250d98)

(cherry picked from commit 02c1045)

Fix a typo ("being" -> "begin") Context: >The streams begin at exactly the same time when play is pressed (cherry picked from commit cf414f7)

Spartan322 added bug enhancement documentation labels Jan 16, 2025

GrahameGW and others added 10 commits January 17, 2025 04:32

Clarify documentation for Geometry2D.line_intersects_line

196233b

(cherry picked from commit f7eb16c)

Updated TreeItem documentation

1569528

(cherry picked from commit 2c78284)

Document time rollover setting in ProjectSettings.xml

ca3f1e0

(cherry picked from commit 25ae74b)

Clarify Timer.start() documentation to match the current behavior.

1eaae64

(cherry picked from commit 336b9a2)

Add tutorial link in Compositor and CompositorEffect docs

2e5bb32

(cherry picked from commit d6ef881)

docs: highlight lack of joystick info on majority of platforms

32c6851

(cherry picked from commit bebf2e8)

Document conversion function needed for normal texture in CompositorE…

30e6261

…ffect (cherry picked from commit abe8d2c)

Fix miscellaneous oddities around the class reference

7af387e

(cherry picked from commit b8f78b1)

Add descriptions to PolygonPathFinder setup and is_point_inside…

dacb91f

… methods (cherry picked from commit 61ddf05)

docs: update UPnP gdscript snippet to latest gdscript

2d5fbb6

This commit adds usage of the new (stringless) signal API. (cherry picked from commit a014705)

Spartan322 force-pushed the 4.3.1-cherry-pick/docs branch from ef9fa1c to 6ff92e9 Compare January 17, 2025 09:32

jadoc and others added 16 commits January 17, 2025 04:39

In Node.xml mentioned that Node::duplicate also copies children.

d636107

The list now uses the Oxford comma. (cherry picked from commit 3e86f7b)

[Doc] Clarify is_null methods of Callable and Signal

07b3d75

(cherry picked from commit 5b91040)

[Doc] Clarify ProjectSettings hdr_2d description

b79e061

(cherry picked from commit 68799be)

Improve documentation on Node2D transform properties such as Skew

b364abb

- Mention the units used for Skew in the inspector and code. (cherry picked from commit c831376)

Fix grammar in AudioStreamInteractive.xml

764212a

Minor grammar fix to make the sentences flow better. (cherry picked from commit 7e1bc00)

Docs: Add cross-links to antialiasing project settings

aa02f40

(cherry picked from commit 4612838)

Clarify the coordinate space for the bounding rectangle returned by L…

d2d58fd

…abel.get_character_bounds (cherry picked from commit c54e49c)

Fix typo in RenderingServer docs

432dabe

(cherry picked from commit 3a1160b)

Document SceneMultiplayer auth_timeout being in seconds

d1944f1

(cherry picked from commit 212c340)

Remove outdated note about not operator with String and StringName

22ac0ef

(cherry picked from commit 90aad07)

Warn for potential performance issues with Auto Switch to Remote Scen…

6d67ac7

…e Tree editor setting (cherry picked from commit 540ac86)

Clarify behavior of InputEvent.is_match and Shortcut.matches_event

69dc2c1

- Shortcut: Clarifies how matches_event() method compares events - InputEvent: Clarifies is_match() method does not consider event states (cherry picked from commit 4f4fd1a)

Clarify docs for when toggling button_pressed emits toggled

da3d864

(cherry picked from commit 3888695)

Clarify PCK path argument in PCKPacker.pck_start

b357ff8

Co-authored-by: Rémi Verschelde <[email protected]> (cherry picked from commit 7b7164c)

Fix a typo in make_rst.py (Packedfloat64Array -> PackedFloat64Array)

f96544b

(cherry picked from commit 21fb753)

FlooferLand and others added 19 commits January 17, 2025 05:10

Update Z Index property location in Node2D class reference

b5a1095

The Z Index property is in CanvasItem since Godot 4.0, so it's shared among Node2D and Control. (cherry picked from commit d683ea4)

Fix TODO comments in class reference

cefdb00

(cherry picked from commit 30a573e)

Add a code sample that extracts all files to ZIPReader documentation

c3874f4

Tested with various ZIP files found on the web, with a single root folder or multiple files at its root. Co-authored-by: Raul Santos <[email protected]> (cherry picked from commit 4db9c11)

Fix incorrect Z direction for AABB's position

00c73de

(cherry picked from commit e0b1300)

Rewrite some @GlobalScope keys in documentation to use [code] tags

3c0dcf4

(cherry picked from commit e653f19)

Update PackedVector4Array description to include explanation shared b…

bae03fa

…y PackedArray classes (cherry picked from commit acf351f)

Fix missing sign in ease function curve description

9403f65

The range was broken because -1.0 was informed as being 1.0. (cherry picked from commit 84f4178)

Update screen_get_scale documentation.

e531ad9

(cherry picked from commit 3413c6c)

Update CanvasLayer 'Follow Viewport' documentation to match its behavior

05b8c88

(cherry picked from commit 5d111e8)

Remove outdated note about BaseMaterial3D.billboard_mode shadow issue

aecb7f6

The linked pull request was merged in Godot 4.3. (cherry picked from commit e499563)

Document GPUParticles.emit_particle() only working on Forward+ and …

5bf1f36

…Mobile (cherry picked from commit 49ca40c)

Fix warning in CollisionPolygon2D documentation description

cf3c056

This was a copy-paste error from the CollisionShape2D documentation. (cherry picked from commit 54a4a87)

Add TileMap tutorials to TileMapLayer class reference

0eb9c1f

- Add Dynamic TileMap Layers demo link as well. (cherry picked from commit 5bda507)

Fix typo in Basis get_rotation_quaternion doc

b57cda6

(cherry picked from commit 1250d98)

Clarify expected types in RayCast3D documentation

c1758c9

(cherry picked from commit 02c1045)

Spartan322 force-pushed the 4.3.1-cherry-pick/docs branch from 716ffe9 to 877b1ed Compare January 17, 2025 10:10

Spartan322 added topic:core topic:rendering topic:shaders labels Jan 17, 2025

Fix typo in AudioStreamSynchronized.xml

28a7784

Fix a typo ("being" -> "begin") Context: >The streams begin at exactly the same time when play is pressed (cherry picked from commit cf414f7)

Spartan322 force-pushed the 4.3.1-cherry-pick/docs branch from 877b1ed to 28a7784 Compare January 17, 2025 15:20

Spartan322 marked this pull request as ready for review January 17, 2025 15:22

charlottewiltshire0 approved these changes Jan 17, 2025

View reviewed changes

mcdubhghlas approved these changes Jan 17, 2025

View reviewed changes

Spartan322 merged commit eb03e31 into Redot-Engine:4.3 Jan 17, 2025
18 checks passed

Spartan322 deleted the 4.3.1-cherry-pick/docs branch January 17, 2025 17:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[4.3] Cherry-picks for the 4.3 (4.3.1) branch - 1st docs batch #925

[4.3] Cherry-picks for the 4.3 (4.3.1) branch - 1st docs batch #925

Spartan322 commented Jan 16, 2025 •

edited

Loading

[4.3] Cherry-picks for the 4.3 (4.3.1) branch - 1st docs batch #925

[4.3] Cherry-picks for the 4.3 (4.3.1) branch - 1st docs batch #925

Conversation

Spartan322 commented Jan 16, 2025 • edited Loading

Spartan322 commented Jan 16, 2025 •

edited

Loading