6175fe2511
Adds a meta on top of every generated class to hide 'Edit on Github' link
...
Linked docs issue https://github.com/godotengine/godot-docs/pull/2656
(cherry picked from commit d83b8881ae
2019-07-29 15:26:33 +02:00
8d69f1651c
Improve the documentation of the Object class
...
I edited the main description to remove parentheses and split long sentences.
Closes #29382
Closes #29384
(cherry picked from commit 21a0dad58a
2019-07-29 15:19:47 +02:00
d83e80e039
Make KinematicBody docs consistent regarding `test_only` argument
...
This simply makes the `move_and_collide` method descriptions in
both 2D and 3D to be in sync.
Co-authored-by: 2DemiGods <2DemiGods@users.noreply.github.com>
(cherry picked from commit 8ba50823c4
2019-07-29 15:19:21 +02:00
8f8bae9ba5
[DOCS] Update CPUParticles[2D] classref
...
(cherry picked from commit 9f7713d98b
2019-07-29 15:19:06 +02:00
2e58e3dbe8
filled out docs for various mesh types
...
(cherry picked from commit ef45f5ce75
2019-07-29 15:17:17 +02:00
efee888a6e
Improved documentation of rsplit Method for String class.
...
Improved documentation of rsplit Method for String class.
Removed "divisor" (i will also change variants_call.cpp) and added "delimiter" in its place. Also moved the example at the bottom of the description.
(cherry picked from commit 1a397f46e6
2019-07-29 15:16:59 +02:00
5dd0ed81a1
Adding missing description for method and fixing typo
...
(cherry picked from commit 77b6f3e812
2019-07-29 15:16:38 +02:00
24f17f2208
doc: Fix DocData.merge_from copying old setters and getters
...
This is not necessary and means that some setters and getters
can end up wrong if they are changed in the bindings but DocData
does not update them when running --doctool.
Fixes #29425 .
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
(cherry picked from commit e1e3fcc908
2019-07-29 15:16:17 +02:00
d54733eba3
Improve @GDScript.assert documentation
...
Mention that assert only runs in debug builds, closes #29154
(cherry picked from commit 6f1f887078
2019-07-29 15:15:22 +02:00
2bfd81d49d
Correct typos in RigidBody axis lock documentation
...
(cherry picked from commit b06dc6ba8c
2019-07-29 15:15:03 +02:00
1e5c7d0a23
Improve AudioStreamSample documentation.
...
"Squash" of #27928 .
Wording based on suggestions by @LikeLakers2.
(cherry picked from commit a3aa98cb88
2019-07-29 15:14:49 +02:00
78a24be155
Improve the PrimitiveMesh-derived class documentations
...
(cherry picked from commit 30474b8215
2019-07-29 15:14:33 +02:00
320b361e16
Add example usage for get_rect()
...
(cherry picked from commit fbf4135fc1
2019-07-29 15:13:52 +02:00
e2e5e4c44e
Add "GUI skinning" tutorial link to the 'Theme' doc
...
(cherry picked from commit b3c2305160
2019-07-29 15:13:30 +02:00
d846a0aaa3
Change "Return" to "Returns" where necessary in XML documentation
...
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".
Fixes #28867
(cherry picked from commit 426bcc9941
2019-07-29 15:12:52 +02:00
ce786bd100
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback]
...
(cherry picked from commit 47b8615a2e
2019-07-29 15:07:29 +02:00
eae0ef9a80
doc: Document default value for PhysicsBody collision layers
...
Supersedes #28971 .
Co-authored-by: Mitch Curtis <mitch.curtis@qt.io>
(cherry picked from commit f3b8fe47b0
2019-07-29 15:06:01 +02:00
99f15173c1
Clarify auto_advance.
...
Make the docs more clear about how you can use auto_advance. Calling it
a "variable" is vague, so I updated the docs to clearly state that it
becomes a boolean parameter on the AnimationTree.
Fixes godotengine/godot-docs#2439 .
(cherry picked from commit 20168b5fbf
2019-07-29 15:05:44 +02:00
086895604a
Add description for EditorPlugin.update_overlays
...
(cherry picked from commit 5fe2bf125a
2019-07-29 15:05:20 +02:00
044f0abbd9
Add "String Formatting" tutorial link to the 'String' doc
...
(cherry picked from commit 3197898c88
2019-07-29 15:05:04 +02:00
8b8a9049b7
Improve the CanvasItem documentation
...
This makes it clear that line width and antialiasing in
`draw_multiline()` aren't implemented yet (see #16448 ).
(cherry picked from commit 1cfa74bf92
2019-07-29 15:04:21 +02:00
2dd7121841
Docs: Add tutorials for KinematicBody2D
...
(cherry picked from commit 36e9af4812
2019-07-29 15:03:15 +02:00
00c00ab083
Improved the AnimatedSprite docs; added description to speed_scale.
...
(cherry picked from commit ece6d37eef
2019-07-29 15:02:27 +02:00
a7c76e8bb1
changed references to array types in arraymesh doc
...
(cherry picked from commit e8858a9a44
2019-07-29 15:01:56 +02:00
ba8cf0431d
makerst: Fix format of [url] links in reST
...
Moved some logic to make_url in an attempt to reuse it in the parser,
but it proved too complex so I ended up not using it. I kept it as a
separate method nevertheless.
(cherry picked from commit c7246d8e1e
2019-07-29 15:00:48 +02:00
6521d64c46
Add support for [url=] tag to makerst.py
...
Fixes #28904
(cherry picked from commit 102f73b88a
2019-07-29 14:57:10 +02:00
728d1eee4f
Improve the ProjectSettings documentation
...
(cherry picked from commit 436d000066
2019-07-29 14:55:20 +02:00
dea5dafea5
Consistently wrap booleans in [code]
...
(cherry picked from commit b0846f60c9
2019-07-29 14:54:32 +02:00
fa2f739ee0
Add example of loading a font from .ttf file
...
As this is a multi-step process it would be nice to have this documented.
(cherry picked from commit c89cc44a5e
2019-07-29 14:52:11 +02:00
df6a6a2004
doc: Sync classref with current source
2019-07-05 11:34:47 +02:00
8cee39fe21
updated description of Array.shuffle to properly describe that it uses the same common seed at every runtime, thus being reproducible in general
...
(cherry picked from commit d02ecd5a18
2019-07-03 13:19:40 +02:00
d963a32213
Document dictionary erase return value
...
(cherry picked from commit 5ce9bfcb4f
2019-07-03 13:19:40 +02:00
31ba78e4bd
Update of RigidBody2D class description
...
Added a hint in the RigidBody2D class description regarding the transformation issue mentioned in https://github.com/godotengine/godot/issues/5734
(cherry picked from commit 1170b78e28
2019-07-03 13:19:40 +02:00
4c6327e426
Document CollisionObject2D pickable requires collision_layer
...
Documents CollisionObject2D mouse_entered, mouse_exited and input_event requiring at least one collision_layer to be set.
(cherry picked from commit da73bcca6f
2019-07-03 13:19:40 +02:00
3086084ace
Small documentation improvements
...
(cherry picked from commit 04b49264f2
2019-07-03 13:19:40 +02:00
f156b2e1cd
doc: Make all tutorial links track "3.1" in 3.1 branch
...
See discussion in #29104 .
2019-06-01 11:39:37 +02:00
a485d862f1
doc: Sync classref with current source
2019-04-25 14:00:31 +02:00
4fefc0896d
Delete <demos> tag from HeightMapShape xml
2019-04-21 00:11:01 +02:00
71753edeae
Added normally distributed generation function to RNG
...
(cherry picked from commit 5f137925dc
2019-04-20 23:39:04 +02:00
49df4b7a7a
Added height map shape that implement heightmap collision shape
...
(cherry picked from commit 8627f1515b
2019-04-20 23:33:50 +02:00
6ab01490f5
Added smoothstep built-in function
...
(cherry picked from commit 514a3fb96a
2019-04-20 23:30:56 +02:00
340bf6e80c
Added direction_to method to vectors
...
(cherry picked from commit 55f3bd97a2
2019-04-20 23:24:35 +02:00
9535a6079e
Added functions to AStar for disable/enable points
...
(cherry picked from commit cc71fb2308
2019-04-20 23:21:06 +02:00
94f6c3a810
Make AnimatedSprite able to play backwards
...
(cherry picked from commit 4a2c433028
2019-04-20 23:17:21 +02:00
e0fe795433
Add object encoding param to serialization methods
...
Network peers get_var/put_var
File get_var/store_var
GDScript/Mono/VisualScript bytes2var/var2bytes
Add MultiplayerAPI.allow_object_decoding member which deprecates PacketPeer.allow_object_decoding.
Break ABI compatibaility (API compatibility for GDNative).
(cherry picked from commit 393e62b98a
2019-04-20 23:15:02 +02:00
a1ad05df86
Multiplayer API now respects allow_object_decoding
...
Add doc about allow_object_decoding in PacketPeer
(cherry picked from commit 53ab3a1ba9
2019-04-20 23:14:54 +02:00
4f3fc559bc
Added method to clear all points in Line2D
...
(cherry picked from commit 61b22beeae
2019-04-20 22:14:16 +02:00
759c1fb0b8
Added signal for Tween emitted at completion
...
(cherry picked from commit a19e99aacb
2019-04-20 22:13:33 +02:00
456eb53439
Remove unused imports
...
(cherry picked from commit 49a81308c0
2019-04-20 20:15:44 +02:00
7a94bac34e
Document SceneTree.get_frame() and persistent in add_to_group
...
(cherry picked from commit 1e9128238e
2019-04-19 13:12:30 +02:00
53d73f59eb
doc: Drop unused <demos> tag
...
(cherry picked from commit 6af69f851a
2019-04-19 13:10:25 +02:00
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
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
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
f12848f9e1
Document String's 'is_valid_filename()'
...
(cherry picked from commit 70499faff8
2019-04-19 13:05:06 +02:00
28f547a021
Added some documentation for Slider
...
(cherry picked from commit de4877e1fc
2019-04-19 13:04:51 +02:00
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
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
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
0eeb1a7d0d
Added minimal documentation for _get_configuration_warning method
2019-04-12 02:56:26 -04:00
a4610ca61e
Clarify encoding used for text by the File class
...
(cherry picked from commit d1c095b30a
2019-04-06 21:14:47 +02:00
5ec63c62a1
Add documentation about nested YSort nodes.
...
(cherry picked from commit ed3586afa1
2019-04-03 16:49:34 +02:00
d02ee1ff0e
Corrects small typo in atan2() documentation.
...
(cherry picked from commit 9838c4df7c
2019-03-27 17:31:29 +01:00
4740489a97
[DOC] Physics[2D]DirectBodyState updates
...
(cherry picked from commit bb2e6e3ed2
2019-03-27 17:31:29 +01:00
e9796044ed
Better documentation for some move_and_slide parameters
...
(cherry picked from commit 0e93714ff7
2019-03-27 17:31:29 +01:00
f7ff3ec749
[DOCS] Add tutorial link to Particles2D
...
(cherry picked from commit bc8aa32593
2019-03-27 17:31:29 +01:00
a51b2b8a82
[DOCS] minor classref updates
...
(cherry picked from commit 454b701e76
2019-03-16 10:42:06 -07:00
4023d52399
Made the tooltip position offset configurable
...
(cherry picked from commit 30c07c1ae1
2019-03-16 10:41:08 -07:00
77c26d3260
linked tutorials in the classref
...
(cherry picked from commit 67446ff733
2019-03-13 20:09:17 +01:00
51f6138cb3
doc: Sync classref with current source
2019-03-12 17:03:35 +01:00
db8f26c8e5
AudioStreamSample: Don't crash when writing to file fails
2019-03-12 15:51:07 +01:00
61771ad39b
doc: Fix style for vararg in makerst
2019-03-10 11:31:27 +01:00
b22cf46fdb
Request Android record permission when needed
2019-03-08 12:38:36 -03:00
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
8f5d9b6391
doc: Sync classref with current source
2019-03-07 10:54:42 +01:00
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
4d9b7b9803
makerst: make vararg methods look the same as in editor help
2019-03-05 20:42:09 +01:00
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
1b4228cb48
Remove "TODO" instances in the docs
2019-03-05 11:02:44 -03:00
5cfedd46ce
Further clarify docs for #26545
2019-03-04 09:53:02 -03:00
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
df2491c253
Merge pull request #26354 from Pobega/elaborate-manual-animation-quirks
...
docs: Elaborate AnimationPlayer manual advancing
2019-02-27 21:42:08 +01:00
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
cab790a49d
Update ScrollContainer description to be less ambiguous.
2019-02-27 12:24:56 -05:00
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
88a36e20cb
doc: Sync classref with current source
2019-02-25 11:22:41 +01:00
51bd516a07
doc: Fix wrong tag
2019-02-25 11:17:56 +01:00
08c3a2241d
[DOCS] Minor classref updates.
2019-02-24 20:30:26 -08:00
9bfc491384
Merge pull request #25683 from wombatstampede/patch-1
...
Update CPUParticles.xml
2019-02-23 00:36:04 +01:00
8b9ec8bc88
Document that ViewportTexture is flipped on Y
...
Fixes #26141 .
2019-02-22 15:11:32 +01:00
5dc4893f2e
Add descriptions for the 'MergeMode's in 'UndoRedo' docs
2019-02-21 11:07:41 -03:00
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
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
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
e7018e4017
ProjectSettings: fix category for per pixel transparency settings
2019-02-20 14:45:02 +01:00
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
ec94370053
Add warnings to docs for methods that return copies, not refs.
2019-02-19 20:03:40 -08:00
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
4e0eb752c2
doc: Fix style issues
2019-02-18 09:45:10 +01:00
1ffd1bc8f3
doc: Sync classref with current source
2019-02-18 09:35:29 +01:00
StraToN
Nathan Lovato
Andrii Doroshenko (Xrayez)
Chris Bradfield
clayjohn
Zak
Maxime Leroy
Rémi Verschelde
Cheeseness
follower
Hugo Locurcio
Tomasz Chabora
Michael Alexsander Silva Dias
Sean Heffernan
Ryan Roden-Corrent
volzhs
Guilherme Felipe
Ken Paulson
Stanislav
hbina085
lopho
Thomas Karcher
Jiří Procházka
Hein-Pieter van Braam-Stewart
Chaosus
Bastiaan Olij
Fabio Alessandrelli
Hendrikto
Soham Kar
Siddharth
toasteater
Hasan Yusuf Ahmed
shartte
Juan Linietsky
Jared
homer666
Andrettin
merumelu
DESKTOP-3H3MR3A\eloisa
Juan Linietsky
psuhas77
Michael Pobega
nuke
Pieter-Jan Briers
Joseph Catrambone