Commit Graph

3553 Commits

Author SHA1 Message Date
Hugo Locurcio dba3a8d2aa Document workarounds for 2D line and polygon antialiasing
(cherry picked from commit 1bdcba2d76)
2022-05-05 15:18:18 +02:00
Hugo Locurcio 698dc5cae8 Document the ProximityGroup class
Co-authored-by: MJacred <loesch.benny92@gmx.de>
(cherry picked from commit fb345a924d)
2022-05-05 15:17:42 +02:00
Hugo Locurcio 9fec145ebe Improve documentation for tonemapping operators
(cherry picked from commit 035cb7fcb0)
2022-05-05 15:17:29 +02:00
twi 06ac7dc21f Update link to vector2_angle_to_point.png
(cherry picked from commit 718533552c)
2022-05-05 15:16:08 +02:00
Markus Sauermann 60184f08f4 Add a note about collisions in different canvases.
(cherry picked from commit b9c91d620e)
2022-04-13 12:18:45 +02:00
Ryan Roden-Corrent 5b098bf41b Clarify Array.erase for nonexistant element.
The docs specify that Array.remove does nothing if the index does not
exist. Array.erase does not have a similar phrase, so it's unclear if
erase will print an error, or silently do nothing.

(cherry picked from commit f84e2db35e)
2022-04-13 12:18:45 +02:00
nova++ 6a788fe7a3 Fixing some of my own typos...
(and a little improvement to wording that was bugging me)

(cherry picked from commit 05718796db)
2022-04-13 12:18:45 +02:00
Haoyu Qiu 6432d53f10 Fix capitalization of boolean output in classref
(cherry picked from commit 94a5f9edb0)
2022-04-13 12:18:45 +02:00
Hugo Locurcio 95252110c5 Improve documentation related to 3D material vertex lighting
(cherry picked from commit 4e6dfac969)
2022-04-13 12:18:45 +02:00
Hugo Locurcio 152c4c7434 Clarify what `set_as_toplevel()` does in CanvasItem
(cherry picked from commit 196c4fff13)
2022-04-13 12:18:45 +02:00
Rémi Verschelde 64d3520faf doc: Fix String.rsplit code example
Fixes #36898.
Supersedes and closes #36951.

(cherry picked from commit e7fd0ec31f)
2022-04-13 12:18:45 +02:00
Haoyu Qiu 91c7c40d50 Document how to specify explicit value for `PROPERTY_HINT_ENUM` names
(cherry picked from commit 405bc96a1e)
2022-04-13 12:18:45 +02:00
zacryol d298cceeaa update _init() description
Specify details regarding required parameters.

(cherry picked from commit 21fc3cbe81)
2022-03-22 09:29:33 +01:00
Ricardo Buring 91ba6f7895 Document that PhysicsServer's get_process_info is implemented only for Godot Physics
(cherry picked from commit 812d45ea7c)
2022-03-22 08:57:28 +01:00
Hugo Locurcio b5ff9fd7c4 Mention that Node's `owner` must be set for persistence to work
This is already done in `Node.add_child()` documentation, but
this copies the note in `Node.owner` for good measure.

(cherry picked from commit be1acf3b92)
2022-03-22 08:56:36 +01:00
Hugo Locurcio 5d1858dcea Document Range's `value_changed` signal is also emitted with code changes
This also mentions that the signal is potentially emitted every frame,
which can have performance implications.

(cherry picked from commit cdbb31adc9)
2022-03-17 13:06:15 +01:00
Marcel Admiraal 1a5b379a68 Update documentation for Control rect_pivot_offset to include rotation
(cherry picked from commit d2c0ee700a)
2022-03-17 13:05:17 +01:00
Hugo Locurcio d57b7cb0e5 Clarify the position of points in `Curve{2D,3D}.add_point()`
(cherry picked from commit 35c8d332b5)
2022-03-13 15:35:05 +01:00
lawnjelly 69c3abedf0 Correct docs for Environment background keep mode
The docs incorrectly stated that KEEP was the fastest mode. This is not the case with modern hardware.

(cherry picked from commit bc924d4b41)
2022-03-13 15:34:45 +01:00
Markus Sauermann e7d9a40a8b Fix documentation about depth and width of Height map
(cherry picked from commit 2cafaf3adb)
2022-03-13 15:34:33 +01:00
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
Max Hilbrunner f00260f1b7
[3.x] Fix make_rst.py on Windows
(cherry picked from commit 54de063890)
2022-01-25 18:49:52 +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