Commit Graph

1607 Commits

Author SHA1 Message Date
Rémi Verschelde 53d73f59eb doc: Drop unused <demos> tag
(cherry picked from commit 6af69f851a)
2019-04-19 13:10:25 +02:00
Soham Kar aa0d4ffe51 Fixed copy&paste error #28117
Changed "left to right" in VSplitContainer to "top to bottom".

(cherry picked from commit aa8b2f4448)
2019-04-19 13:05:50 +02:00
Rémi Verschelde af12b2d18b doc: Add note about VisibilityNotifier.is_on_screen after instantiation
Fixes #9430.

(cherry picked from commit 3fc1f7dfbe)
2019-04-19 13:05:36 +02:00
Siddharth d99a0a5fba fixes #25707 documentation of v_scroll_speed
Fixes #25707

Update TextEdit.xml

(cherry picked from commit 3f2aac5e0a)
2019-04-19 13:05:20 +02:00
Michael Alexsander Silva Dias f12848f9e1 Document String's 'is_valid_filename()'
(cherry picked from commit 70499faff8)
2019-04-19 13:05:06 +02:00
Tomasz Chabora 28f547a021 Added some documentation for Slider
(cherry picked from commit de4877e1fc)
2019-04-19 13:04:51 +02:00
Ryan Roden-Corrent fd4a65df7b Fill out some of the AnimationNode docs.
The API docs for various animation nodes are pretty empty, yet the
tutorial at
https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html
contains some details.

These details should be included in the API docs so looking up a
particular class actually provides some information rather than
requiring the user to hunt for a different tutorial.

This also links the AnimationTree tutorial and demo in the docs.
I've found the TPS demo to be the best resource so far for learning
how to use the AnimationTree. This should be easy to find if someone
looks up the AnimationTree API docs.

Finally, this fixes a param typo in AnimationNodeStateMachine.

(cherry picked from commit 584288a32c)
2019-04-19 13:04:22 +02:00
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