Commit Graph

2887 Commits

Author SHA1 Message Date
Nova d35d49171f Added or improved documentation to a few more String methods
(cherry picked from commit f159e7e5ab)
2022-03-01 10:56:09 +01:00
Markus Sauermann 77ba87be88 Update doc for match: empty argument doesn't match anything
(cherry picked from commit 70ae6c21de)
2022-03-01 10:53:01 +01:00
skyace65 857fac65b1 Add more information on triangulate polygon
(cherry picked from commit bcc4d26c48)
2022-02-24 10:33:35 +01:00
Hugo Locurcio 2f95efcaaf Document glow rendering caveats when using GLES3 on mobile
(cherry picked from commit 595d67ae8b)
2022-02-24 10:23:23 +01:00
Hugo Locurcio c93408b568 Document that meshes and lights must be fully set up before baking GIProbe
(cherry picked from commit def35898e4)
2022-02-19 16:00:41 +01:00
Haoyu Qiu 885c9bdfbd Fix wording in AnimationNode classref
(cherry picked from commit bc37b0508b)
2022-02-19 15:46:38 +01:00
Haoyu Qiu 46037af570
Fix documentation about TreeItem button ID
(cherry picked from commit bb766a8fb6)
2022-02-17 10:44:05 +01:00
Hugo Locurcio 83bfc89466
Document Light contact shadows often looking broken
(cherry picked from commit 9171737e2b)
2022-02-17 10:41:53 +01:00
Hugo Locurcio 2c174cbc0a
Clamp environment light sky contribution to the [0.0; 1.0] range
The value is already clamped in the editor, but it wasn't being
clamped when the value was set via code. Values outside the [0.0; 1.0]
range can result in broken rendering.

(cherry picked from commit 08128351a5)
2022-02-17 10:41:37 +01:00
Hugo Locurcio 8af41b1c58
Improve documentation for AudioServer device properties and methods
(cherry picked from commit 743b5608e3)
2022-02-17 10:41:11 +01:00
Hugo Locurcio 9f020ec777
Clarify identical `hash()` return values due to collisions
(cherry picked from commit 08541fe11d)
2022-02-17 10:39:39 +01:00
Hugo Locurcio 87e96ca24c
Improve the `AudioStreamPlayer2D/3D.area_mask` documentation
The documentation was stating that the area mask affects where sounds
can be heard, which is not true. Instead, the area mask affects audio
bus redirection.

Thanks to Azedaxen on the Godot forums for providing this description :)

(cherry picked from commit ab1eaac315)
2022-02-17 10:34:57 +01:00
TechnicalSoup 04e9de3d71
Expand description for warp_mouse_position method
Add more detail to the description for the warp_mouse_position method, clarifying that the vector is in screen coordinates and relative to an origin at the top of the game window.

(cherry picked from commit 3dc1fad262)
2022-02-17 10:31:12 +01:00
Max Hilbrunner 6ce71b78a7
DOCS: Object.set() does nothing on type mismatch
(cherry picked from commit bb7d003881)
2022-02-17 10:26:38 +01:00
Rémi Verschelde 1891c8e172
doc: Fixup invalid use of `$DOCS_URL` in `3.4` branch 2022-02-04 16:07:47 +01:00
SnailRhymer f4814ab711
Backport improved look_at docs and errors
Take extra constraint info and function description from Node3D.look_at to improve Spatial.look_at docs.
Add an explicit error for up == 0

(cherry picked from commit 83298da9b8)
2022-02-02 23:13:26 +01:00
Hugo Locurcio 97ee014434
Clarify documentation for Rect2's `has_no_area()`
(cherry picked from commit 7f00317f67)
2022-02-02 23:12:42 +01:00
Ev01 7753688f88
Fixes invalid links to tutorials in AudioStreamGenerator, AudioStreamGeneratorPlayback, and AudioEffectSpectrumAnalyzer class references
(cherry picked from commit b6c543179c)
2022-01-31 20:40:04 +01:00
Hugo Locurcio 9827d620e3
Improve documentation for `ReflectionProbe.max_distance` property
(cherry picked from commit c35968e276)
2022-01-31 20:38:55 +01:00
Wysocki Patryk db1105d4b3
Expose AnimationNodeOneShot::mix_mode as a property
Fixes #23458.

(cherry picked from commit f16c483c9d)
2022-01-25 18:56:36 +01:00
Rémi Verschelde 055fb93e56
doc: Clarify expected type of `Object *` parameters in Tree methods
They're meant to be `TreeItem *` but this can't be bound in Variant.

Fixes #20538.

(cherry picked from commit 81f2ce4e46)
2022-01-25 18:52:17 +01:00
SnailRhymer ad12f54778
Add clarification to tile_set_modulate
To resolve 45677, adds a note to tile_set_modulate clarifying how to use tile_modulate in shaders.

(cherry picked from commit 6ac800aab7)
2022-01-25 18:50:48 +01:00
Hugo Locurcio 7e32d42968
Document that soft bodies should be avoided for gameplay purposes
(cherry picked from commit 94b1ae5599)
2022-01-25 18:49:00 +01:00
LoserFox d218356ae8
Fix some errors in Environment documentation
Co-authored-by: Clay John <claynjohn@gmail.com>
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
(cherry picked from commit 0af26280b6)
2022-01-25 18:48:48 +01:00
skyace65 4f3cc52426
Better explain JSON print indent parameter (3.x)
(cherry picked from commit c540a17efc)
2022-01-25 18:47:24 +01:00
rafallus 92073c2fcd
Fix `input_ray_pickable` documentation for `CollisionObject3D`
(cherry picked from commit ba7d3f8331)
2022-01-25 18:45:35 +01:00
kobewi 8db41cf94d
Clarify to_float() and to_int() methods
(cherry picked from commit 7bb682651f)
2022-01-25 18:44:49 +01:00
bruvzg d0d1e81696
[Documentation] Add instruction how to execute built-in commands of various shells.
(cherry picked from commit 9faf1e027a)
2022-01-25 18:44:25 +01:00
kobewi 7fade16b55
Mention that modifying text erases BBCode stacks
(cherry picked from commit 3f0e9da5a4)
2022-01-25 18:42:41 +01:00
QueenOfSquiggles c7a9ec4c29
Fixed a typo in BakedLightmap documentation
"capture_propagation" member documentation description was missing the second 'p' in "propagation". Fixed this minor typo
Also resubmitting pull request to 3.x branch as per @Calinou's recommendation.

(cherry picked from commit cab89124ff)
2022-01-25 18:41:33 +01:00
Haoyu Qiu 73d5851232
Expose `Image.COMPRESS_SOURCE_LAYERED` to scripting
(cherry picked from commit 7f49e5beec)
2022-01-25 18:41:18 +01:00
Hugo Locurcio de148fe51d
Document using SpriteBase3D's `modulate` property with material override
(cherry picked from commit 027a584faf)
2022-01-25 18:38:19 +01:00
skyace65 3f7cb6231d
Fix normal map description
(cherry picked from commit d856074488)
2022-01-12 17:35:00 +01:00
kobewi 90525d5781
Improve FileDialog filters
(cherry picked from commit b403954e41)
2022-01-12 17:34:06 +01:00
kobewi 8012a48585
Improve description of mouse_exited signal
(cherry picked from commit 4eec0032ea)
2022-01-12 17:28:52 +01:00
Hugo Locurcio 9a26e95d5c
Warn when using GPU-based particles on macOS due to low performance
On macOS, Particles rendering is much slower than CPUParticles
due to transform feedback being implemented on the CPU instead
of the GPU.

(cherry picked from commit 299d277c9c)
2022-01-12 16:51:41 +01:00
zacryol f999fe471d
List AnimatedSprite3D in SpriteFrames description
Both AnimatedSprite2D and AnimatedSprite3D use a SpriteFrames resource, but the SpriteFrames
class description currently only lists being used with the 2D variant.

(cherry picked from commit 4391f6a5b5)
2022-01-12 16:44:27 +01:00
Sam ad00d99b49
Fixed typos in MeshDataTool documentation
- Fixed missing "be" typo in MeshDataTool's get_face_edge function
- Corrected documentation to say negative values aren't valid

(cherry picked from commit bc9df365b0)
2022-01-12 16:41:33 +01:00
zacryol 3839342175
Update description of FileDialog `filters` property
specify that multiple filetypes/extensions can be included in one filter within the
PackedStringArray, and provide an example

(cherry picked from commit 123cfb4759)
2022-01-12 16:36:46 +01:00
Arnav Vijaywargiya 596bf6bdaa
Fixed incorrect property types
(cherry picked from commit 0c46f73b5e)
2022-01-12 16:34:07 +01:00
bruvzg b7fbfc2776
Add joystick button index boundary check. Increase max. button number to 128 (max. buttons supported by DirectInput).
(cherry picked from commit 61ea8f8337)
2022-01-12 16:29:19 +01:00
skyace65 e0ea177cf9
Add note om when tween methods return false (3.x)
(cherry picked from commit 4bd1ce49e6)
2022-01-12 16:28:53 +01:00
skyace65 e62363ec89
Document how to erase project settings with set_setting
(cherry picked from commit 290038952f)
2022-01-12 16:16:07 +01:00
David Cambré dd9121040e
Update default port_grab_distance_vertical
(cherry picked from commit 38ad72af44)
2022-01-12 16:03:28 +01:00
Wilson E. Alvarez 2106c5175a
Expose autotile_coord parameter in TileMap.set_cellv
(cherry picked from commit 4106f95f30)
2022-01-12 16:03:02 +01:00
follower 74b1560672
Fix the "AudioEffectRecord" descriptions.
The `AudioEffectRecord` effect has no microphone capture-specific functionality--it can be used with any audio bus.

This patch attempts to clarify this fact (so people like me who want to capture audio output know they're in the right place) while still providing a pointer use of the effect with `AudioStreamMicrophone` for microphone capture.

(cherry picked from commit 022f49437b)
2022-01-12 16:01:18 +01:00
Rémi Verschelde 2e8fdd0112
Fix typos with codespell
Using codespell 2.1.0.

Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
fave
findn
GIRD
leapyear
lod
merchantibility
nd
numer
ois
ony
que
readded
seeked
statics
synching
te
uint
unselect
webp
EOF

$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```

(cherry picked from commit b197de6f5f)
2022-01-07 00:17:47 +01:00
bruvzg cb6d82a111
Fix multiple missing UTF-8 decoding.
(cherry picked from commit c69e0d16bc)
2022-01-06 21:30:41 +01:00
kobewi 7324ad6462
Fix get_v_scroll() desctiption in ItemList
(cherry picked from commit f97ab4a0e4)
2022-01-06 00:58:33 +01:00
Lertsenem e807d2e6f0
Fix error in Vector2.reflect() description
The description was probably copied from Vector3.reflect(), and
unfortunately did not match the 2D behaviour (where n is apparently the
direction vector of the symmetry line, not the normal).

(cherry picked from commit e1bf428cdc)
2022-01-06 00:58:33 +01:00