godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
20,098 Commits 15 Branches 59 Tags 2.2 GiB
Commit Graph

1675 Commits

Author SHA1 Message Date
Zak 6f637b2bf3 Document MarginContainer Node 
(cherry picked from commit 9f582a7c3e)
 2019-07-29 16:16:39 +02:00
Randall Fulton 1137ccb050 Add docstring for Object.set_deferred 
(cherry picked from commit 6843ad87a4)
 2019-07-29 16:16:03 +02:00
Hugo Locurcio a08141120e Improve the `Engine.get_version_info()` documentation 
This documents some keys that were missing and improves formatting.

(cherry picked from commit 03335e5250)
 2019-07-29 16:15:37 +02:00
Zak 02a8c1d9fe Document ReferenceRect Node 
Added missing documentation for ReferenceRect Node

(cherry picked from commit 5d0040e340)
 2019-07-29 16:15:09 +02:00
unknown 29fbb408ec Added description to is_pixel_opaque() in Sprite.xml 
(cherry picked from commit 44a20a0f61)
 2019-07-29 16:06:02 +02:00
Rémi Verschelde 0893bb9a02 doc: Improve docs for Resource* classes 
Also move module-specific classes to their own module's `doc_classes`
folder.

(cherry picked from commit 0764451dc5)
 2019-07-29 16:05:01 +02:00
Zak b279f225c0 Document TextEdit node 
(cherry picked from commit 1f81981b3d)
 2019-07-29 16:01:14 +02:00
Nathan Lovato 040e1dd411 Add documentation for Bone2D 
(cherry picked from commit c12fc1ade1)
 2019-07-29 16:00:15 +02:00
Zak 7cd696f1b5 Document ItemList control 
(cherry picked from commit 49df253627)
 2019-07-29 15:59:52 +02:00
Ertain 0e21648419 Corrected spelling error 
(cherry picked from commit 7a397d6976)
 2019-07-29 15:59:34 +02:00
tree786 ffab827683 Update VehicleWheel.xml 
It seems (please correct me if you understand it otherwise) that the description for the `get_skidinfo()` function is the inverse of what actually happens. I have run some simple tests, and it looks like setting low `Friction Slip` (e.g. try `1` or `2`) causes more skidding and returns smaller values for `get_skidinfo()`, while when the `Friction Slip` is increased, the car skids less and values printed to the console increase (get closer to `1.0`). So it seems that a value of `0.0` means skidding, while a value of `1.0` means no skidding (the description says the exact opposite to this, from what I understood).

(cherry picked from commit e9b8ff273d)
 2019-07-29 15:58:53 +02:00
Nathan Lovato a9d7f2ed9b Add documentation for AnimationNode* resources 
I haven't put [code] bbcode around the amount of the AnimationNodeAdd* classes
because it's not exposed to GDScript.
Same for the +add, -add, etc. labels: they're just labels you can find in the
AnimationTree bottom panel.

(cherry picked from commit d0eb99f970)
 2019-07-29 15:58:36 +02:00
Maxime Leroy a6316d8a56 Adding details about `Image.lock()` function 
(cherry picked from commit f1e2324605)
 2019-07-29 15:57:41 +02:00
Maxime Leroy 8947e9f438 Fixing returned alpha component for inverted method 
See `core/color.cpp:217`, alpha channel is not changed.

(cherry picked from commit 024d595850)
 2019-07-29 15:57:21 +02:00
Ken Paulson d05f673669 Changes to OS.has_feature() docs: 
- Added link to the Feature Tags documentation
 - Added note that tag names are case-sensitive

(cherry picked from commit 349e924cad)
 2019-07-29 15:56:42 +02:00
Aspin 26e25a8c1b More accurate description of valid Parents 
I hope this is the right place to edit now.

(cherry picked from commit a9ddf2a449)
 2019-07-29 15:55:34 +02:00
Chaosus cd662249f5 Fix smooth_step to smoothstep docs 
(cherry picked from commit d725e4e6c0)
 2019-07-29 15:50:58 +02:00
Hugo Locurcio c8944e380a Document built-in LineEdit keybindings 
(cherry picked from commit 9b86233e32)
 2019-07-29 15:50:07 +02:00
StraToN 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
Nathan Lovato 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
Andrii Doroshenko (Xrayez) 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
Chris Bradfield 8f8bae9ba5 [DOCS] Update CPUParticles[2D] classref 
(cherry picked from commit 9f7713d98b)
 2019-07-29 15:19:06 +02:00
clayjohn 2e58e3dbe8 filled out docs for various mesh types 
(cherry picked from commit ef45f5ce75)
 2019-07-29 15:17:17 +02:00
Zak 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
Maxime Leroy 5dd0ed81a1 Adding missing description for method and fixing typo 
(cherry picked from commit 77b6f3e812)
 2019-07-29 15:16:38 +02:00
Rémi Verschelde 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
Nathan Lovato 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
Cheeseness 2bfd81d49d Correct typos in RigidBody axis lock documentation 
(cherry picked from commit b06dc6ba8c)
 2019-07-29 15:15:03 +02:00
follower 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
Hugo Locurcio 78a24be155 Improve the PrimitiveMesh-derived class documentations 
(cherry picked from commit 30474b8215)
 2019-07-29 15:14:33 +02:00
Tomasz Chabora 320b361e16 Add example usage for get_rect() 
(cherry picked from commit fbf4135fc1)
 2019-07-29 15:13:52 +02:00
Michael Alexsander Silva Dias e2e5e4c44e Add "GUI skinning" tutorial link to the 'Theme' doc 
(cherry picked from commit b3c2305160)
 2019-07-29 15:13:30 +02:00
Sean Heffernan 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
Chris Bradfield ce786bd100 [DOCS] Add descriptions to AnimationNodeStateMachine[Playback] 
(cherry picked from commit 47b8615a2e)
 2019-07-29 15:07:29 +02:00
Rémi Verschelde 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
Ryan Roden-Corrent 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
volzhs 086895604a Add description for EditorPlugin.update_overlays 
(cherry picked from commit 5fe2bf125a)
 2019-07-29 15:05:20 +02:00
Michael Alexsander Silva Dias 044f0abbd9 Add "String Formatting" tutorial link to the 'String' doc 
(cherry picked from commit 3197898c88)
 2019-07-29 15:05:04 +02:00
Hugo Locurcio 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
Guilherme Felipe 2dd7121841 Docs: Add tutorials for KinematicBody2D 
(cherry picked from commit 36e9af4812)
 2019-07-29 15:03:15 +02:00
Ken Paulson 00c00ab083 Improved the AnimatedSprite docs; added description to speed_scale. 
(cherry picked from commit ece6d37eef)
 2019-07-29 15:02:27 +02:00
clayjohn a7c76e8bb1 changed references to array types in arraymesh doc 
(cherry picked from commit e8858a9a44)
 2019-07-29 15:01:56 +02:00
Rémi Verschelde 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
Stanislav 6521d64c46 Add support for [url=] tag to makerst.py 
Fixes #28904

(cherry picked from commit 102f73b88a)
 2019-07-29 14:57:10 +02:00
Hugo Locurcio 728d1eee4f Improve the ProjectSettings documentation 
(cherry picked from commit 436d000066)
 2019-07-29 14:55:20 +02:00
Tomasz Chabora dea5dafea5 Consistently wrap booleans in [code] 
(cherry picked from commit b0846f60c9)
 2019-07-29 14:54:32 +02:00
follower 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
Rémi Verschelde df6a6a2004 doc: Sync classref with current source 2019-07-05 11:34:47 +02:00
hbina085 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
lopho d963a32213 Document dictionary erase return value 
(cherry picked from commit 5ce9bfcb4f)
 2019-07-03 13:19:40 +02:00