Commit Graph

1650 Commits

Author SHA1 Message Date
toasteater 8d87f624eb Improve RandomNumberGenerator docs.
Clarified behavior of a few methods. Added implementation notes so
that developers not familiar with RNGs are alerted to common pitfalls.

(cherry picked from commit ae1393acae)
2019-04-19 13:03:28 +02:00
Rémi Verschelde a033640276
Merge pull request #27304 from hasahmed/patch-1
Added minimal documentation for _get_configuration_warning method
2019-04-12 12:47:54 +02:00
Hasan Yusuf Ahmed 0eeb1a7d0d Added minimal documentation for _get_configuration_warning method 2019-04-12 02:56:26 -04:00
shartte a4610ca61e Clarify encoding used for text by the File class
(cherry picked from commit d1c095b30a)
2019-04-06 21:14:47 +02:00
Juan Linietsky 5ec63c62a1 Add documentation about nested YSort nodes.
(cherry picked from commit ed3586afa1)
2019-04-03 16:49:34 +02:00
Jared d02ee1ff0e Corrects small typo in atan2() documentation.
(cherry picked from commit 9838c4df7c)
2019-03-27 17:31:29 +01:00
Chris Bradfield 4740489a97 [DOC] Physics[2D]DirectBodyState updates
(cherry picked from commit bb2e6e3ed2)
2019-03-27 17:31:29 +01:00
Tomasz Chabora e9796044ed Better documentation for some move_and_slide parameters
(cherry picked from commit 0e93714ff7)
2019-03-27 17:31:29 +01:00
homer666 f7ff3ec749 [DOCS] Add tutorial link to Particles2D
(cherry picked from commit bc8aa32593)
2019-03-27 17:31:29 +01:00
Chris Bradfield a51b2b8a82 [DOCS] minor classref updates
(cherry picked from commit 454b701e76)
2019-03-16 10:42:06 -07:00
Andrettin 4023d52399 Made the tooltip position offset configurable
(cherry picked from commit 30c07c1ae1)
2019-03-16 10:41:08 -07:00
clayjohn 77c26d3260 linked tutorials in the classref
(cherry picked from commit 67446ff733)
2019-03-13 20:09:17 +01:00
Rémi Verschelde 51f6138cb3 doc: Sync classref with current source 2019-03-12 17:03:35 +01:00
merumelu db8f26c8e5 AudioStreamSample: Don't crash when writing to file fails 2019-03-12 15:51:07 +01:00
Rémi Verschelde 61771ad39b doc: Fix style for vararg in makerst 2019-03-10 11:31:27 +01:00
DESKTOP-3H3MR3A\eloisa b22cf46fdb Request Android record permission when needed 2019-03-08 12:38:36 -03:00
Rémi Verschelde c74bf2e6b1 Define android/modules globally so it appears in Project Settings
Until now people had to add it manually to project.godot to load custom modules.
2019-03-07 11:25:58 +01:00
Rémi Verschelde 8f5d9b6391 doc: Sync classref with current source 2019-03-07 10:54:42 +01:00
Rémi Verschelde b4d5c1ab5b
Merge pull request #26633 from akien-mga/driver-fallback-etc
Disable driver fallback to GLES2 by default
2019-03-06 00:57:49 +01:00
merumelu 4d9b7b9803 makerst: make vararg methods look the same as in editor help 2019-03-05 20:42:09 +01:00
Rémi Verschelde b0f782a0e3 Disable driver fallback to GLES2 by default
GLES2 is not designed to be a drop-in replacement for the GLES3 backend,
so the fallback mode has to be used knowingly. It *can* make sense for
simple projects which make sure to handle the differences between both
rendering backends, but most users should stick to one supported backend.

By making it opt-in, we can now use this parameter to define whether to
export ETC textures to Android and iOS when using GLES3 + Fallback.

When using GLES3 without Fallback on Android, set the proper min GLES
version in the AndroidManifest.

Also made the option boolean and renamed it for clarity and to avoid
conflict with the previous String option (which would always evaluate as
"true" otherwise).

Fixes #26569.
2019-03-05 16:36:46 +01:00
Michael Alexsander Silva Dias 1b4228cb48 Remove "TODO" instances in the docs 2019-03-05 11:02:44 -03:00
Juan Linietsky 5cfedd46ce Further clarify docs for #26545 2019-03-04 09:53:02 -03:00
psuhas77 52125af7a0 mentioned possible use of property:component syntax
Referencing #26466  , added possible use of property:component syntax for functions like interpolate_property, follow_property,etc.. in the class description.
2019-03-03 01:26:54 +05:30
Rémi Verschelde df2491c253
Merge pull request #26354 from Pobega/elaborate-manual-animation-quirks
docs: Elaborate AnimationPlayer manual advancing
2019-02-27 21:42:08 +01:00
Michael Pobega ffa22c9273 Elaborate AnimationPlayer manual advancing
Elaborate the difference between AnimationPlayer::advance and
AnimationPlayer::seek, specifically how intermediary events are handled for
each.

From the docs it is unclear that AnimationPlayer::advance is more of a
'fast-forward', playing each event (including function calls) between the two
points.
2019-02-27 15:34:23 -05:00
nuke cab790a49d
Update ScrollContainer description to be less ambiguous. 2019-02-27 12:24:56 -05:00
Ryan Roden-Corrent b1c221d5ab
Clarify how to use MultiMesh.set_instance_color.
Just calling set_instance_color will do nothing unless you have set
color_format and vertex_color_use_as_albedo. This is really confusing,
and I only discovered my error by finding godotengine/godot#10217 from
another confused user.

The docs should call out these requirements.
2019-02-26 21:41:22 -05:00
Rémi Verschelde 88a36e20cb doc: Sync classref with current source 2019-02-25 11:22:41 +01:00
Rémi Verschelde 51bd516a07 doc: Fix wrong tag 2019-02-25 11:17:56 +01:00
Chris Bradfield 08c3a2241d [DOCS] Minor classref updates. 2019-02-24 20:30:26 -08:00
Hein-Pieter van Braam 9bfc491384
Merge pull request #25683 from wombatstampede/patch-1
Update CPUParticles.xml
2019-02-23 00:36:04 +01:00
Rémi Verschelde 8b9ec8bc88 Document that ViewportTexture is flipped on Y
Fixes #26141.
2019-02-22 15:11:32 +01:00
Michael Alexsander Silva Dias 5dc4893f2e Add descriptions for the 'MergeMode's in 'UndoRedo' docs 2019-02-21 11:07:41 -03:00
Rémi Verschelde b39e1df704 Fix VariantWriter overflow on 64-bit int
Integers in Godot are signed 64-bit ints (int64_t), but var2str used
int behind the scenes and would thus overflow after 2^31.

Also properly documented the actual bounds of int and the behaviour
when overflowing them.
2019-02-21 11:24:00 +01:00
Rémi Verschelde 5d815a5526
Merge pull request #26087 from akien-mga/settings-per-pixel-transparency
ProjectSettings: fix category for per pixel transparency settings
2019-02-20 16:28:24 +01:00
Pieter-Jan Briers d7ae3b8b61 Improve documentation for StyleBox.
I want to just say that the terms used by style boxes are all over the place and quite confusing.
It's even worse internally.
2019-02-20 15:51:07 +01:00
Rémi Verschelde e7018e4017 ProjectSettings: fix category for per pixel transparency settings 2019-02-20 14:45:02 +01:00
Rémi Verschelde d1f68e2eaf Add tooltip for in-editor FPS display in 3D viewport
Also enhance Control/Label documentation about tooltips and mouse filter,
as it took me a while to understand why Labels didn't show tooltips.

Closes #26082.
2019-02-20 12:16:22 +01:00
Joseph Catrambone ec94370053 Add warnings to docs for methods that return copies, not refs. 2019-02-19 20:03:40 -08:00
Rémi Verschelde 7c8fbd892c
Merge pull request #25971 from akien-mga/version-hex
Add hex-encoded version number to Engine singleton for easy comparisons
2019-02-18 13:51:38 +01:00
Rémi Verschelde 4e0eb752c2 doc: Fix style issues 2019-02-18 09:45:10 +01:00
Rémi Verschelde 1ffd1bc8f3 doc: Sync classref with current source 2019-02-18 09:35:29 +01:00
Michael Alexsander Silva Dias 8cc3ae11da Small improvements to the Resource doc 2019-02-17 10:37:23 -03:00
Rémi Verschelde 2e6501d879 Add hex-encoded version number to Engine singleton for easy comparisons 2019-02-17 13:38:52 +01:00
Juan Linietsky 1aa7e22b67 Clear up eof_reached function, fixes #16919 2019-02-17 09:05:32 -03:00
Rémi Verschelde 44d24e8b78
Merge pull request #25952 from pbrunet/fix/rand
Fix typo for randd and randf
2019-02-16 22:05:23 +01:00
Pierrick Brunet 3b6d05db3e Fix typo for randd and randf
* And improve documentation according to issue #25938
2019-02-16 21:05:18 +01:00
Rémi Verschelde 7a79eee523 Expose OS::get_current_video_driver to scripting languages 2019-02-16 14:41:07 +01:00
Rémi Verschelde 325efb60b7
Merge pull request #25776 from luizcarlos1405/master
Fixes some AnimationPlayer bugs
2019-02-13 20:34:35 +01:00
Rémi Verschelde b340b7e804
Merge pull request #25422 from azagaya/optionbutton
Fix docs about item_selected and item_focused . Fixes #25273
2019-02-13 20:31:53 +01:00
Luiz 06a0a29711 Fix some AnimationPlayer bugs and update documentation 2019-02-13 14:40:22 -03:00
Rémi Verschelde 5fc86026ca Fix typos with codespell
Using codespell 1.14.0.

Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
doubleclick
lod
nd
numer
que
te
unselect
EOF
$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```
2019-02-13 09:23:29 +01:00
MidZik ee77cba83e Clarified TileMap get_cell method behavior. 2019-02-12 22:44:39 -06:00
azagaya 7051685a77 Fixes differences between docs and item_selected and item_focused signals in optionbutton
Description in docs about item_selected and item_focused signals in optionbutton is fixed to match the real behaviour. Also, get_item_index function is added.
2019-02-11 08:52:09 -03:00
Rémi Verschelde 6607c3c1c7
Merge pull request #25428 from GlaDos28/master
[DOCS] Added warnings about Dictionary element erasure while iterating over it
2019-02-10 21:40:29 +01:00
Evgeny Savelyev 5594b08e90 added warnings about Dictionary element erasure while iterating over it 2019-02-10 23:28:22 +03:00
Rémi Verschelde f614f15506 doc: Misc formatting fixes 2019-02-10 13:30:48 +01:00
Rémi Verschelde 74932b905e doc: Sync classref with current source 2019-02-10 13:01:03 +01:00
Rémi Verschelde 2975f6e3c4
Merge pull request #25412 from toger5/Doc_impulse_fore
[DOCS] rephrased impulse
2019-02-10 12:56:12 +01:00
Rémi Verschelde 3b3bb8c578
Merge pull request #25728 from clayjohn/doc_multimesh
[DOC] Filled in MultiMesh doc
2019-02-10 11:36:21 +01:00
clayjohn 975c3fd157 filled in multimesh doc 2019-02-09 11:47:25 -08:00
Rémi Verschelde b462fdf1cb
Merge pull request #25685 from Calinou/doc-improve-resourcepreloader
Improve the ResourcePreloader documentation
2019-02-09 12:45:27 +01:00
Rémi Verschelde 0e377f348c
Merge pull request #25517 from Zylann/doc_expression
Explain how to use Expression inputs
2019-02-08 11:55:06 +01:00
Rémi Verschelde 39d6dbbb9f
Merge pull request #25506 from homer666/docs-update-cast-motion
[DOCS] Update PhysicsDirectSpaceState.cast_motion
2019-02-08 11:19:35 +01:00
Hugo Locurcio 4b51e8a975
Improve the ResourcePreloader documentation 2019-02-07 17:00:16 +01:00
wombatstampede d18b89707c
Update CPUParticles.xml
It took me some hours of trying and wondering and one question with a very helpful answer in the facebook group to figure out that the color_ramp gradient actually modifies the vertex color of the particle mesh (but NOT the albedo). After knowing this enabling vertex_color_use_as_albedo in the SpatialMaterial led to success.

I hope adding this little hint:
"Each particle's vertex color will vary along this [GradientTexture]."

Might help other people which stumble upon this...
2019-02-07 16:12:38 +01:00
Marc Gilleron 08ea2aedd2 Explain how to use Expression inputs 2019-01-31 15:52:17 +01:00
homer666 07e27cd197 [DOCS] Update PhysicsDirectSpaceState.cast_motion 2019-01-31 20:39:40 +11:00
toger5 ef99f034b4 [DOCS] rephrase impulse
- improove coordinate system explanation
 - define usecase
2019-01-29 13:05:20 +01:00
Kyle Szklenski fb61080812
Fix non-compiling typo in Expression.xml example
Slight typo in Expression.xml prevented compilation when copy/pasted.
2019-01-28 16:38:13 -05:00
Rémi Verschelde cc0842f9a6 Prevent upscaled SVG from exceeding Image bounds
Also expose Image MAX_WIDTH and MAX_HEIGHT.

Fixes #24455.
2019-01-28 16:00:15 +01:00
Rémi Verschelde 2ad6212a3f
Merge pull request #25372 from JFonS/add_gizmo_docs
Minor fixes and documentation for Spatial Gizmos
2019-01-27 19:06:42 +01:00
JFonS e90fb5b0ab Minor fixes and documentation for Spatial Gizmos 2019-01-27 18:40:01 +01:00
Rémi Verschelde 17b2b17471 Document AnimatedTexture and bind MAX_FRAMES constant
Closes #24935.
2019-01-27 13:11:57 +01:00
Rémi Verschelde 433b8ee526 doc: Sync classref with current source 2019-01-26 22:21:53 +01:00
Rémi Verschelde 33d8c19999 doc: Add caveat for File.file_exists for imported resources
Fixes #25347.
2019-01-26 20:25:36 +01:00
danboo aca6e5f4b7 Update Control.xml
The mouse_filter documentation was biased towards button click events, so add more mention of its impact on mouse_entered and mouse_exited signals as well.
2019-01-21 21:39:06 -09:00
Demiu a0640f799b Docs: Fix TileMap::world_to_map description 2019-01-19 15:23:49 +01:00
Rémi Verschelde 7f9209781c
Merge pull request #25059 from TheCoderNextdoor/TheCoderNextdoor-patch-1
doc: Add missing descriptions to Particles2D
2019-01-19 10:18:58 +01:00
Aditya Banerjee ead285bc7c Added missing descriptions to Particles2D
Missing descriptions of property: normal_map, fract_delta, fixed_fps and method: restart(), capture_rect() of Particles2D were added
2019-01-19 06:17:39 +05:30
Aaron Franke 763353692b Improve docs for KinematicBody linear_velocity, fixes #23927 2019-01-18 17:48:16 -05:00
Rémi Verschelde 7ae4cb7f7d
Merge pull request #25093 from akien-mga/lerp-returns-variant
GDScript: Fix return value of "lerp" builtin
2019-01-18 12:32:23 +01:00
Rémi Verschelde d024979e84 GDScript: Fix return value of "lerp" builtin
Fixes #25082, fixes #24709.
2019-01-18 10:47:04 +01:00
M. Huri 3b9b684179 [Docs] Fixed a typing glitch in ARVRServer.xml 2019-01-18 14:07:33 +07:00
Chris Bradfield 725eb9de8c DOCS: correction to move_and_slide description 2019-01-16 13:26:17 -08:00
Rémi Verschelde 07e2046980
Merge pull request #24924 from danilo2205/rename-oriented-path-follow
Merge OrientedPathFollow into PathFollow
2019-01-16 19:24:44 +01:00
Danilo Villa (Davi) e74a3add9c Rename OrientedPathFollow to PathFollowOriented 2019-01-16 14:32:18 -02:00
corrigentia e7844505b1 Docs: Language fixes in ARVR reference 2019-01-16 10:37:11 +01:00
Rémi Verschelde 72f501de13 GLES2: Fix typo in project setting
It used a different name than the equivalent GLES3 parameter.
2019-01-15 13:26:54 +01:00
Rémi Verschelde 02ffc59270 GLES2: Make Nvidia flicker workaround opt-in
It has a big impact on 2D and text rendering performance (cf. #24466)
so the solution seems worse than the bug it aims to work around.

It's now opt-in via "rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround"
for those who need it and have a simple enough game for the performance
drop not to be an issue.

Fixes #24466.
2019-01-14 19:02:07 +01:00
Poommetee Ketson 57b82873fb
Docs: fix arg name of toggled signal in BaseButton
arg was renamed in #15530 but the description wasn't updated
2019-01-11 09:51:39 +07:00
Rémi Verschelde 9eb9335608 doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:29 +01:00
clayjohn a6722cf362 clarified and filled out particles material doc 2019-01-07 12:26:36 +01:00
Rémi Verschelde a15620c83e doc: Fix wrong references found by Sphinx and new makerst.py 2019-01-07 12:15:01 +01:00
Rémi Verschelde 698728f1c2
Merge pull request #24640 from PJB3005/18-12-28-makerst-2
makerst.py refactor.
2019-01-07 10:11:54 +01:00
Rémi Verschelde 26fddb77be doc: Fix wrong references found by new makerst.py
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
Timo Schwarzer 5c71d43302
Add missing documentation for @GDScript 2019-01-06 14:35:40 +01:00
Rémi Verschelde 53516d7a9e
Merge pull request #24608 from PJB3005/18-12-26-control-docs
Improve documentation of Control.
2019-01-06 13:15:15 +01:00
Pieter-Jan Briers c93c279867 Improve documentation of Control. 2019-01-04 18:12:24 +01:00