Commit Graph

3570 Commits

Author SHA1 Message Date
Rémi Verschelde
373ec9a8a2 Input: Document that accumulated input is disabled by default
This was actually disabled by mistake in 3.4 causing a regression, but since
this issue survived the whole 3.4.x series and it's now very close to 3.5,
it's too late to change it again.

We might consider it for 3.6 after some beta testing.

Fixes #55037.

(cherry picked from commit 7de45b6203)
2022-07-07 14:15:50 +02:00
salamandars
5fcdbfb2be Clarify that MeshInstance surface methods only apply to override materials
(cherry picked from commit 22881a6923)
2022-07-07 14:11:35 +02:00
Yuri Sizov
7a87fd232b Fix return type for the exposed EditorResourcePicker method
(cherry picked from commit d9bf3e5e35)
2022-07-03 18:30:41 +02:00
Hugo Locurcio
716e4e0c2e Handle CLI arguments without a value in OS.get_cmdline_args() example
Command lines such as `--host --address 127.0.0.1` are now parsed as
`{"host": "", "address": "127.0.0.1"}`.

(cherry picked from commit 99d9228a2e)
2022-06-19 14:14:43 +02:00
Hugo Locurcio
49fc84da4a Improve CurveTexture documentation
(cherry picked from commit 87f22083af)
2022-06-19 14:14:01 +02:00
Haoyu Qiu
8f59e837a8 Remove extra codeblock tag from ProximityGroup classref
(cherry picked from commit c197e11363)
2022-06-19 14:13:06 +02:00
Nikola Whallon
5446443504 added info on microphone sample format
(cherry picked from commit eb5a42d0bc)
2022-06-19 14:12:53 +02:00
Sergey Pershenkov
230a047d5f draw_circle() draws a filled circle
(cherry picked from commit adccb9fd60)
2022-06-19 14:12:36 +02:00
skyace65
da0ade279b Fix rigid body damp description (3.x)
(cherry picked from commit c0ecbeaf6f)
2022-06-19 14:12:07 +02:00
Hugo Locurcio
bccc403823 Change instances of "returns an empty Variant" to "returns null" in docs
While "returns an empty Variant" technically valid (it's constructed
as `Variant()` in C++), "returns null" is more intuitive to users.

(cherry picked from commit 109f968171)
2022-06-19 14:11:56 +02:00
dtesniere
05a48a189a Fix class name : change "string" to "String"
Change case of "s" letter : "string" does not compile but "String" does (for gdScript)

(cherry picked from commit 55b63eceaa)
2022-06-19 14:11:39 +02:00
SnailRhymer
49282b59d6 Document Shape2D's collide_and_get_contacts() and collide_with_motion_and_get_contacts()
Expand on the format of the output array for collide_and_get_contacts and collide_with_motion_and_get_contacts, and describe how the contact point pairs can be used to calculate collision normals and depths.

(cherry picked from commit bdf086c781)
2022-06-19 14:10:29 +02:00
Hugo Locurcio
cde4ed1d21 Improve documentation for Camera3D.project_ray_{normal,origin}
This mentions that internally, the inverse camera projection is used
to perform projections.

(cherry picked from commit fbec10179a)
2022-06-19 14:09:45 +02:00
Rémi Verschelde
afe8492241 Fix typos with codespell
Using codespell 2.2-dev from current git.

Fix a couple incorrect uses of gendered pronouns.
2022-06-19 14:06:55 +02:00
kleonc
3993510fc6 Tree::get_edited Fix in docs example code
(cherry picked from commit b0bcbcc094)
2022-05-05 15:47:02 +02:00
kobewi
33bcf1c5d1 Clarify InputMap.action_get_events() in the editor
(cherry picked from commit 5235584066)
2022-05-05 15:47:01 +02:00
PureAsbestos
62c48a0cf9 Change 'throws an error' to 'prints an error' in classref
(cherry picked from commit a89b3f872d)
2022-05-05 15:47:01 +02:00
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