Commit Graph

20123 Commits

Author SHA1 Message Date
Hugo Locurcio 1f8470eaf2 doc: Mention `Input.MOUSE_MODE_CAPTURED` is raw on Windows and Linux
(cherry picked from commit f4e99e2e39)
2019-07-29 17:47:46 +02:00
hbina085 f45b8c36fd Clarify what %APPDATA% expands to in Windows
Linux users should be familiar with "~" so I think it might be unnecessary.
Also changed the file separator in the description to use Windows' instead.

(cherry picked from commit 5f68ae93b5)
2019-07-29 17:47:46 +02:00
lmp f011721a6e Clearify how hex_to_int expects a '0x' prefixed string. Provide a small hex_to_int example
(cherry picked from commit cebb38e0b3)
2019-07-29 17:47:46 +02:00
Remi Rampin 417f223e63 DOC: Fix spelling
See also https://github.com/godotengine/godot-docs/pull/2595

(cherry picked from commit ddfd67401f)
2019-07-29 17:47:46 +02:00
Tomasz Chabora 6891c942a1 Clarify better what Node.raise does
(cherry picked from commit a26f52db33)
2019-07-29 17:47:46 +02:00
Marco Costa e9f4886253 Document constants in Transform/Transform2D
(cherry picked from commit f99e84d180)
2019-07-29 17:47:46 +02:00
Hugo Locurcio d81ca21a6c Fix Nintendo buttons in the @GlobalScope documentation
These were mistakenly referred to as DualShock buttons.

(cherry picked from commit 398219a80e)
2019-07-29 17:47:46 +02:00
Rémi Verschelde 0cccb6b4fa doc: Complete GlobalScope documentation
(cherry picked from commit 5aafc62a9b)
2019-07-29 17:47:46 +02:00
unknown 7dd98f3de7 Added descriptions to OS.get_splash_tick_msec() and OS.get_window_safe_area()
(cherry picked from commit f2fd5dfb91)
2019-07-29 17:47:46 +02:00
tree786 37e9ec842c doc: UPNP: Add example on how to open/close a port
I have added a small code sample to show how to automate the process of port forwarding (and closing after you are done).
Thanks to @mhilbrunner for explaining how to achieve t0his (see #18780)

(cherry picked from commit 2a63853720)
2019-07-29 17:47:46 +02:00
Zak 3e8b2d2063 Document SpinBox node
(cherry picked from commit f9cbd34fe0)
2019-07-29 17:47:46 +02:00
Zak baebe22ab0 Document PopupMenu node.
(cherry picked from commit 316931998c)
2019-07-29 17:47:46 +02:00
Tomasz Chabora e7899b9e35 Clarify docs for _ready and request_ready
(cherry picked from commit b71a339160)
2019-07-29 17:47:46 +02:00
Rémi Verschelde 383c678a1e doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
(cherry picked from commit bc82781f7d)
2019-07-29 17:32:54 +02:00
Rémi Verschelde 7a97fd99c7 Properly expose all Error constants to scripting languages
(cherry picked from commit 1bf448dd87)
2019-07-29 17:32:54 +02:00
Rémi Verschelde 755896b036 doc: Complete and harmonize all _MAX constant descriptions
(cherry picked from commit 86ed7a9884)
2019-07-29 17:32:53 +02:00
tree786 128eaa2718 Added example on how to use RandomNumberGenerator
(cherry picked from commit 68c6790baf)
2019-07-29 16:37:29 +02:00
Rémi Verschelde 055f9f075f doc: Proofread and complete various nodes
All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.

Also fixed some en_GB occurrences as the reference spelling is en_US.

(cherry picked from commit 867dda1124)
2019-07-29 16:35:23 +02:00
Rémi Verschelde ef5b885492 doc: Document NodePath.
(cherry picked from commit 6e9272eea8,
without the Node logic changes)
2019-07-29 16:26:42 +02:00
Rémi Verschelde 558e268edd doc: Document EncodedObjectAsID, expose its property
(cherry picked from commit a9cff880d6)
2019-07-29 16:20:25 +02:00
Marc Gilleron 021347e178 Document VisualServer.instances_cull_ray
(cherry picked from commit cb5233ee12)
2019-07-29 16:19:36 +02:00
Rémi Verschelde b8d29b5c66 doctool: Fix writing theme_item descriptions
We already had support for parsing and saving theme_item descriptions
in DocData, and displaying it in the editor, but doctool would drop the
changes as it was not writing them back to the XML.

Part of #29868.

(cherry picked from commit 615ffb3507)
2019-07-29 16:18:48 +02:00
Chaosus 67efb30f2a Extends wrapi/wrapf docs
(cherry picked from commit 4c137bebe8)
2019-07-29 16:17:43 +02:00
austinried 2f30fb9fec Remove references to mouse stuff from OS
There is nothing in `OS` about mouse grabbing or mouse cursors, that's in `Input`, so I'm cleaning up those references.

(cherry picked from commit 9eeead4be3)
2019-07-29 16:17:13 +02:00
Randall Fulton f8ee310b69 Call out scaling in Spatial.translate docstring
This fixes issue #26938.

(cherry picked from commit bdf51e8e49)
2019-07-29 16:16:58 +02:00
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