Commit Graph

8583 Commits

Author SHA1 Message Date
A Thousand Ships
aec956d7c6
[Doc] Clarify bsearch(_custom) behavior
* Added an example for the effect of `before`
* Clarified the arguments to the custom callable can be either order

(cherry picked from commit 06df4abcd3)
2024-03-11 15:23:49 +01:00
A Thousand Ships
c2ff91c418
[Docs][C#] Use PropertyName constants in more places
(cherry picked from commit 2f1f8ee39b)
2024-03-11 15:23:30 +01:00
Micky
962575ad73
Address a few issues in Transform3D documentation
(cherry picked from commit abf4894677)
2024-03-11 15:23:10 +01:00
A Thousand Ships
dd6eced096
[Doc] Clarify some details about deferred calls
(cherry picked from commit 1cc5b0aa0d)
2024-03-11 15:21:45 +01:00
Rémi Verschelde
bbc06c7cc8
RTL: Clarify that line, paragraph, and character numbers are zero-indexed
Closes #82885.

(cherry picked from commit 4a1397b58c)
2024-03-11 15:20:35 +01:00
A Thousand Ships
201ccb7aeb
[Doc] Fix some incorrect uses of "children"
(cherry picked from commit 9b5cd8e240)
2024-03-11 15:20:07 +01:00
Zi Ye
b0ca5cdc12
Add necessary elaboration to documentation for Node3D::get_parent_node_3d
(cherry picked from commit 4c8015bec3)
2024-03-11 15:18:43 +01:00
Markus Sauermann
e01bf42ca5
Document that parse_input_event doesn't influence the OS
(cherry picked from commit 8121446385)
2024-03-11 15:18:25 +01:00
A Thousand Ships
3eee0c0563
[Doc] Fix GDScript casing of String.num_scientific
(cherry picked from commit b384beccc5)
2024-03-11 15:18:04 +01:00
A Thousand Ships
e96c67d725
Clarify behavior of opening a new file in FileAccess
The containing directory must exist for this to succeed.

(cherry picked from commit a775d8bf5a)
2024-03-11 15:17:45 +01:00
SaNeOr
f518099f73
Additional docs: c# mainloop needs to be registered in the global class
(cherry picked from commit 3122b368c0)
2024-03-11 15:17:23 +01:00
Cariad Eccleston
f63b703f21
Fix "dimensionnal" typo
(cherry picked from commit 9472ccbcdd)
2024-03-11 15:17:02 +01:00
A Thousand Ships
10848d0e80
Fix some leftover references to hint_albedo in docs
(cherry picked from commit e5266f71b9)
2024-03-11 15:16:41 +01:00
Dalton
846892d366
Fix function description for Font.get_char_size()
Removed description implying you can pass a second char in order to account for kerning

(cherry picked from commit c9bc54637b)
2024-03-11 15:14:48 +01:00
Hugo Locurcio
5afb5e3132
Document initial position project settings not affecting run from editor
(cherry picked from commit d3df15f823)
2024-03-11 15:13:45 +01:00
Allen Pestaluky
cbe3bf7511
Fix docs for Color class regarding bits per component.
This fixes godot-docs#8906 ( https://github.com/godotengine/godot-docs/issues/8906 )

(cherry picked from commit 0e977e087c)
2024-03-11 15:13:03 +01:00
Hugo Locurcio
4d45daec12
Document OS.execute() limitations on Android
(cherry picked from commit d94ee14123)
2024-03-11 15:12:39 +01:00
Florian Grabmeier
5e483e5af4
Remove duplicate reference of CUSTOM_ARRAY_RBGA8_URNOM in docs
(cherry picked from commit 02faccd14f)
2024-03-11 15:11:22 +01:00
A Thousand Ships
25e88dd552
Fix inverted link in docs
Title and url were swapped

(cherry picked from commit 17000bf8c3)
2024-03-11 15:10:48 +01:00
Micky
848d93f144
Mention and deprecate InputEventJoypadButton's pressure
(cherry picked from commit 25c0c95960)
2024-03-11 15:09:06 +01:00
Micky
a0a44578aa
Tweak XROrigin3D documentation
(cherry picked from commit 552403d581)
2024-03-11 15:07:57 +01:00
Micky
185cfee96f
Overhaul Transform3D documentation
(cherry picked from commit 64ba22a9a7)
2024-03-11 15:07:11 +01:00
Micky
ccc4f49c22
Add missing documentation for AudioStream & AudioStreamPlayback
(cherry picked from commit 8f4598bad4)
2024-03-11 15:04:53 +01:00
Micky
44fc5956aa
Add a few notes to Sprite3D's documentation
(cherry picked from commit 8ca47c981d)
2024-03-11 15:04:31 +01:00
Micky
6b734531a3
Overhaul documentation about MIDI support
(cherry picked from commit 8723d116c4)
2024-03-11 15:03:58 +01:00
20kdc
fd9f1a7c41
Fix the documentation of Bone2D::apply_rest (squashed)
Co-authored-by: Micky <66727710+Mickeon@users.noreply.github.com>
(cherry picked from commit f16f8bf39b)
2024-03-11 15:03:11 +01:00
Hugo Locurcio
3e4519fc2f
Document Bounce = 1.0 not being sufficient for infinite energy conservation
(cherry picked from commit 7ff1704b1b)
2024-03-11 15:02:53 +01:00
Lucas Clemente Vella
cdf8e0e87c
Improve docs on how ParallaxLayer mirroring works.
I wrote everything I wish was written when I tried to make an
infinite scrolling background, addressing every point of every
mistake I made.

(cherry picked from commit 40813b68f0)
2024-03-11 15:02:20 +01:00
kobewi
3c76c89cc7
Clarify Tween.set_parallel()
(cherry picked from commit 207bd34aa5)
2024-03-11 15:01:25 +01:00
ShirenY
211dd2fb53 Transform mesh's AABB to skeleton's space when calculate mesh's bounds.
(cherry picked from commit 27f71c4e78)
2024-01-24 18:54:11 +01:00
Hugo Locurcio
e2c96dc711 Document changing the window's resizable status at runtime
(cherry picked from commit d6768a17fa)
2024-01-24 18:31:41 +01:00
Micky
1ec0e4fba1 Fixing some reports to String's documentation
Closes https://github.com/godotengine/godot-docs/issues/8043
Closes https://github.com/godotengine/godot-docs/issues/8044
Mitigates https://github.com/godotengine/godot-docs/issues/8190
Closes https://github.com/godotengine/godot/issues/86734

(cherry picked from commit 46b0f3e9d6)
2024-01-24 18:31:27 +01:00
jsjtxietian
f5c7a0e832 Mention CollisionPolygon2D.polygon is local to the given CollisionPolygon2D
(cherry picked from commit f5409dc132)
2024-01-24 18:30:59 +01:00
Micky
45fc8a3b43 Add missing descriptions for Image's documentation
(cherry picked from commit e01b91777a)
2024-01-24 18:30:59 +01:00
Micky
c02fcb4ede Add missing descriptions to TextServer's constants
(cherry picked from commit d3150c9c8f)
2024-01-24 18:27:37 +01:00
Quincy Wofford
57fe32f8da corrected tooltip information Roll Influence property of VehicleWheel3D
(cherry picked from commit c979d02db2)
2024-01-24 18:20:39 +01:00
Hugo Locurcio
c72c69379a Improve RichTextLabel install_effect() documentation
(cherry picked from commit 78fff7292c)
2024-01-24 18:20:38 +01:00
Michael Macha
0904f0affd Remove pointer to deprecated class page, from Skeleton3D
SkeletonIK3D is now deprecated, but Skeleton3D is recommending looking into its use for complicated inverse kinematics. What's worse, the removed line is not perfectly clear for non-developers and people less experienced with the engine, and could still stand to be improved.

(cherry picked from commit 0e52ffeb69)
2024-01-24 18:20:38 +01:00
A Thousand Ships
ab7d9578b7 Clarify PackedByteArray.decompress* limitations with external data
(cherry picked from commit 4850b866e8)
2024-01-24 18:04:32 +01:00
CardboardCarl
b3018d81c5 Clarified behavior of RayCast objects when get_collision_point() is used inside a collision shape
(cherry picked from commit 6dfec4f70d)
2024-01-24 18:00:50 +01:00
Erik Johnson
dfcd70c09f Add descpription for rendering/limits/spatial_indexer/threaded_cull_minimum_instances
(cherry picked from commit 498f46063d)
2024-01-24 18:00:49 +01:00
31
2c062f1922 Include animation.length in Animation example
The length of an Animation isn't automatically set by adding keys, and
it must be set manually. The existing example only has keys up to 0.5s,
so the default value of 1.0s may be acceptable. However, this results in
unexpected behavior for anyone who makes an animation longer than 1.0s.
Include animation.length in the example because it's important.

Also, increase the key position to 2.0s so it won't be confusing that
the assignment is somewhat redundant.

(cherry picked from commit 698c67d540)
2024-01-24 18:00:49 +01:00
Micky
5ffc22b06f Add missing descriptions to PrimitiveMesh and SoftBody3D
(cherry picked from commit a33777d49d)
2024-01-24 18:00:49 +01:00
addmix
87798576f0 Improve documentation for CameraAttributesPhysical.exposure_shutter_speed
(cherry picked from commit b7b0022c7a)
2024-01-23 20:22:00 +01:00
Hugo Locurcio
da200b99c9 Improve and clarify texture filtering documentation
- Mention the Use Nearest Mipmap Filter project setting.
- Fix nearest mipmap claiming to always use bilinear filtering
  (it uses trilinear filtering by default, like linear mipmap).

(cherry picked from commit 47cadda3ad)
2024-01-23 20:22:00 +01:00
Rémi Verschelde
98cfa8bcf2 VideoPlayer: Fix reloading translation remapped stream
Fixes #43917.

(cherry picked from commit 7d0c561e02)
2024-01-23 20:22:00 +01:00
Nico
2ff7b6c830 Specify the behaviour of get_tree when the node is not in the scene tree
(cherry picked from commit ee9c8cb296)
2024-01-23 20:00:34 +01:00
clayjohn
9c82571dd6 Fill out Material documentation and clarify render_priority and next_pass sorting
(cherry picked from commit 6a663959a6)
2024-01-23 20:00:23 +01:00
Hugo Locurcio
b468496700 Don't apply frame delay project setting to the editor
This appears to already be the case for the Max FPS project setting.

(cherry picked from commit a63556212d)
2024-01-23 19:15:02 +01:00
Anutrix
b3b9342bf1 Added docs for DRAW_ORDER_REVERSE_LIFETIME constant and minor XR log improvement
(cherry picked from commit 3c82f4a371)
2024-01-23 19:15:02 +01:00