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

1656 Commits

Author SHA1 Message Date
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
Thomas Karcher
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
lopho
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
Jiří Procházka
3086084ace Small documentation improvements 
(cherry picked from commit 04b49264f2)
 2019-07-03 13:19:40 +02:00
Rémi Verschelde
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
Rémi Verschelde
a485d862f1 doc: Sync classref with current source 2019-04-25 14:00:31 +02:00
Hein-Pieter van Braam-Stewart
4fefc0896d Delete <demos> tag from HeightMapShape xml 2019-04-21 00:11:01 +02:00
Chaosus
71753edeae Added normally distributed generation function to RNG 
(cherry picked from commit 5f137925dc)
 2019-04-20 23:39:04 +02:00
Bastiaan Olij
49df4b7a7a Added height map shape that implement heightmap collision shape 
(cherry picked from commit 8627f1515b)
 2019-04-20 23:33:50 +02:00
Chaosus
6ab01490f5 Added smoothstep built-in function 
(cherry picked from commit 514a3fb96a)
 2019-04-20 23:30:56 +02:00
Chaosus
340bf6e80c Added direction_to method to vectors 
(cherry picked from commit 55f3bd97a2)
 2019-04-20 23:24:35 +02:00
Chaosus
9535a6079e Added functions to AStar for disable/enable points 
(cherry picked from commit cc71fb2308)
 2019-04-20 23:21:06 +02:00
Michael Alexsander Silva Dias
94f6c3a810 Make AnimatedSprite able to play backwards 
(cherry picked from commit 4a2c433028)
 2019-04-20 23:17:21 +02:00
Fabio Alessandrelli
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
Fabio Alessandrelli
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
Chaosus
4f3fc559bc Added method to clear all points in Line2D 
(cherry picked from commit 61b22beeae)
 2019-04-20 22:14:16 +02:00
Chaosus
759c1fb0b8 Added signal for Tween emitted at completion 
(cherry picked from commit a19e99aacb)
 2019-04-20 22:13:33 +02:00
Hendrikto
456eb53439 Remove unused imports 
(cherry picked from commit 49a81308c0)
 2019-04-20 20:15:44 +02:00
Tomasz Chabora
7a94bac34e Document SceneTree.get_frame() and persistent in add_to_group 
(cherry picked from commit 1e9128238e)
 2019-04-19 13:12:30 +02:00
Rémi Verschelde
53d73f59eb doc: Drop unused <demos> tag 
(cherry picked from commit 6af69f851a)
 2019-04-19 13:10:25 +02:00