Commit Graph

2353 Commits

Author SHA1 Message Date
Chris Bradfield
bc234ce0ae [Docs] Description updates for Node2D & Object 2019-12-26 10:24:29 -08:00
Lakshay Angrish
fe9a4ff818 add area_shape_entered usage 2019-12-26 17:30:48 +05:30
Lakshay Angrish
c37429b281 add AngelCode format in BitmapFont doc's description 2019-12-26 11:12:02 +05:30
Hugo Locurcio
c719cea116
Add an example of using HTTPRequest to contact a REST API
We already had an example to download and display an image,
but having another example dedicated to REST APIs doesn't hurt.
2019-12-24 23:24:16 +01:00
willnationsdev
e182aa0d32 Fix KinematicCollision docs mislabeling an ObjectID as an RID. 2019-12-24 15:35:58 -06:00
Ryan Roden-Corrent
67f441a09d
Clarify ImmediateGeometry.add_vertex.
It isn't obvious whether you should add vertices in global coordinates,
or local to the ImmediateGeometry Node.
2019-12-23 23:20:32 -05:00
Ryan Roden-Corrent
e002044761
Be more specific about array return values.
The prior docs weren't clear if {pop_,}{front,back} would fail or return
`null` on an empty array.
2019-12-22 14:38:10 -05:00
Rémi Verschelde
56d44aaac9
Merge pull request #34090 from Calinou/doc-improve-basis
Improve the Basis class documentation
2019-12-22 20:37:48 +01:00
Hugo Locurcio
bb62c07fce
Improve the Basis class documentation 2019-12-22 18:04:51 +01:00
Hugo Locurcio
0bab51ab55
Fix the Node process_priority description to match actual behavior
This closes #34531.
2019-12-22 17:01:56 +01:00
Rémi Verschelde
4bec32a11e
Merge pull request #34400 from alexchond/alexchon
Document DUPLICATE_USE_INSTANCING #2770
2019-12-22 12:36:42 +01:00
Rémi Verschelde
18e4fb3548
Merge pull request #34413 from Zacxalot/vehiclewheel-tooltip
Update VehicleWheel.xml
2019-12-22 12:34:34 +01:00
Rémi Verschelde
0b776ebbe4
Merge pull request #34498 from KoBeWi/bad_idea
Mention that bbcode_text += string is a bad idea
2019-12-21 14:38:54 +01:00
Tomasz Chabora
abbff65dc8 Mention that bbcode_text += string is a bad idea 2019-12-21 10:45:26 +01:00
Tomasz Chabora
2b1fb0375d Mention how to handle cancel in ConfirmationDialog 2019-12-21 00:19:16 +01:00
Rémi Verschelde
b3a70f0b80
Merge pull request #34357 from clayjohn/DOCS-VisualServer
Updated docs for many VisualServer methods
2019-12-20 09:20:29 +01:00
clayjohn
f88f762240 Updated docs for many VisualServer methods 2019-12-19 18:24:51 -08:00
alexchond
e26b066871 DUPlICATE_USING_INSTANCE documentation update 2019-12-19 17:17:57 +02:00
Haoyu Qiu
a58deee648 Updates docs of AABB and Plane 2019-12-18 15:14:38 +08:00
Rémi Verschelde
4f18c134b9
Merge pull request #34412 from flyingpimonster/docs-optionbutton
Docs: OptionButton
2019-12-18 07:59:32 +01:00
Zacxalot
13b77c9acd Update VehicleWheel.xml
VehicleWheels roll influence values in the tool tip were the wron way round.
2019-12-17 23:27:41 +00:00
James Westman
575a1dc9cf Docs: OptionButton
Complete the documentation and make some existing descriptions a bit
clearer.

Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
2019-12-17 16:45:18 -06:00
Hugo Locurcio
6cf1499eaf
Improve the KEY_MASK_CMD documentation 2019-12-17 18:26:21 +01:00
alexchond
be3fc17603 Document DUPLICATE_USE_INSTANCING #2770 2019-12-17 13:41:36 +02:00
Rémi Verschelde
c64c46db1d doc: Sync classref with current source 2019-12-17 11:43:07 +01:00
Rémi Verschelde
f8ea390b52
Merge pull request #34269 from KoBeWi/scrolling_peeps
Scroll ScrollContainer to focused children
2019-12-16 14:03:21 +01:00
Rémi Verschelde
6ec42b7507
Merge pull request #34372 from KoBeWi/how_to_graphnode
Mention how to add slots to GraphNode
2019-12-16 08:26:43 +01:00
Tomasz Chabora
078e9c04d2 Mention how to add slots to GraphNode 2019-12-15 23:29:27 +01:00
Aaron Franke
1b8b380993
Document that translated does not behave like rotated or scaled 2019-12-15 12:31:08 -05:00
Rémi Verschelde
d3a07d3550
Merge pull request #33910 from Faless/net/android_mlock
Acquire MulticastLock on Android when using broadcast/multicast
2019-12-14 21:53:08 +01:00
Fabio Alessandrelli
04c917899f Add Android NetSocket implementation.
Automatically acquire and release multicast lock when needed.
2019-12-14 18:10:36 +01:00
Fabio Alessandrelli
9269d6be32 UDP sockets broadcast is now disabled by default.
Add method `set_broadcast_enabled` to allow enabling broadcast via
GDScript.
2019-12-14 17:48:16 +01:00
Rémi Verschelde
a5dcabbbfb
Merge pull request #34272 from MissKraya/34258-fix
Fix for #34258 and added get_zoom_hbox() documentation.
2019-12-14 17:14:41 +01:00
Hannah Crawford
59937e1c54 Updated get_zoom_hbox() documentation. 2019-12-14 14:02:15 +00:00
Danilo Costa Viana
185017b922
Clarifying how float(String from) parses partially invalid strings
Update the description of this method to be in line with [code]int int(String from)[/code] in regards to how it deals with a completely invalid parameter and a partially invalid parameter.
2019-12-13 11:34:26 -03:00
Rémi Verschelde
cf3a863fa9
Merge pull request #34229 from NoFr1ends/fix-home-indicator-ios
Allow to change the home indicator behaviour on iOS
2019-12-13 14:00:14 +01:00
Jonas Bernemann
4d61118f64 Add project setting to hide home indicator on iOS
On iOS devices without a physical home button iOS
shows a home indicator instead. This is often in the
way of the UI or the game.
Added a project setting to disable hidden home indicator.
The default value is to hide the home indicator
2019-12-13 11:00:18 +01:00
Rémi Verschelde
9f68626fb2 doc: Sync classref with current source
Also apply clang-format.
2019-12-13 10:41:06 +01:00
Rémi Verschelde
1cd736951a
Merge pull request #34189 from aaronfranke/mesh-aabb
Expose Mesh get_aabb
2019-12-13 09:14:16 +01:00
Rémi Verschelde
aab70008d3
Merge pull request #34309 from Muller-Castro/VarDeclFix
Fixed HTTPClient.xml:115 and 121 variant declaration
2019-12-12 22:51:58 +01:00
Muller-Castro
f9db01ec50 Fixed HTTPClient.xml:115 and 121 variant declaration 2019-12-12 15:40:17 -03:00
Rémi Verschelde
37d164e24e CharFXTransform: Drop unnecessary get_value_or()
See https://github.com/godotengine/godot/pull/23658#issuecomment-562706669
The method was implemented back when Dictionary.get(key, default) did not
exist, but now that it does we do not need a custom method in CharFXTransform.

It's a new feature in 3.2, so does not break compat with 3.1.x.
2019-12-12 07:47:08 +01:00
Tomasz Chabora
77a8657633 Scroll ScrollContainer to focused children 2019-12-11 14:29:36 +01:00
Aaron Franke
a139104646
Expose Mesh get_aabb 2019-12-11 08:25:36 -05:00
Rémi Verschelde
c868baf658
Merge pull request #34222 from Calinou/doc-collisionshapes
Improve the Shape/Shape2D classes documentation
2019-12-10 10:44:36 +01:00
Hugo Locurcio
16d612dccc
Improve the Shape/Shape2D classes documentation 2019-12-10 08:21:15 +01:00
Hugo Locurcio
3acbabca1e
Document the KinematicBody axis lock methods 2019-12-09 13:45:12 +01:00
Rémi Verschelde
3684810a28
Merge pull request #34164 from Calinou/pckpacker-optional-args
Make some arguments in PCKPacker methods optional
2019-12-09 09:41:52 +01:00
Hugo Locurcio
fe06966181
Make some arguments in PCKPacker methods optional
Those arguments aren't required for most common use cases,
so making them optional should help with code readability.
2019-12-07 01:06:42 +01:00
Hugo Locurcio
7ae0e4be46
Improve the PCKPacker class documentation 2019-12-07 01:00:51 +01:00
Rémi Verschelde
ff58030ed6
Merge pull request #34160 from Calinou/add-makerst-git-hook
Add a pre-commit hook to check the class reference syntax
2019-12-07 00:11:29 +01:00
Rémi Verschelde
07a739e7e1
Merge pull request #34159 from akien-mga/doc-enums-constants
doc: Markup fixes for enums and constants
2019-12-07 00:11:17 +01:00
Rémi Verschelde
643b37aaf0
Merge pull request #34086 from Calinou/doc-improve-stylebox
Improve the StyleBox class documentations
2019-12-07 00:10:57 +01:00
Hugo Locurcio
17add2dc86
Add a pre-commit hook to check the class reference syntax
This also makes documentation helper scripts executable.
2019-12-06 23:40:19 +01:00
Hugo Locurcio
f1a76a8820
Improve the StyleBox class documentations 2019-12-06 23:29:38 +01:00
Rémi Verschelde
4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
Hugo Locurcio
7c6c32b500
Document RichTextEffect and CharFXTransform 2019-12-06 22:50:29 +01:00
Rémi Verschelde
5f64d773ba
Merge pull request #34128 from akien-mga/doc-animplayer-play-stop
doc: Fix and clarify AnimationPlayer play and stop descriptions
2019-12-06 09:35:03 +01:00
Rémi Verschelde
4b64ef88d8
Merge pull request #34132 from flyingpimonster/arvr-docs
Docs: ARVRController and ARVRInterface
2019-12-06 08:38:29 +01:00
James Westman
5978e6afac Docs: ARVRController and ARVRInterface
This commit clarifies a few methods and members in the AR/VR docs. It
also updates some wording according to the style guide and fixes a
couple typos.
2019-12-05 18:10:11 -06:00
Rémi Verschelde
9a12b40100 doc: Fix and clarify AnimationPlayer play and stop descriptions
Closes #34125.
2019-12-05 21:56:31 +01:00
Rémi Verschelde
99b81aa1b9
Merge pull request #34039 from Eoin-ONeill-Yokai/multimeshfix
Added Missing Binding for `multimesh_create` to VisualServer
2019-12-05 06:49:43 +01:00
Eoin O'Neill
f7f7544997 Added method binding for multimesh_create that was missing from VisualServer class. 2019-12-04 16:00:18 -08:00
TerminalJack
e1dda5195c Added support for vertical syncing via the Windows OS compositor (DWM.) 2019-12-04 11:14:21 +01:00
Hugo Locurcio
bc4dbcf793
Travis CI: Run makerst.py to check for documentation errors 2019-12-04 08:51:32 +01:00
bruvzg
0aebba2388
[ci skip] OS class documentations, adds platform compatibility notes. 2019-12-03 18:14:14 +02:00
Rémi Verschelde
a74f0fd4cf doc: Fix markup errors 2019-12-03 10:26:20 +01:00
Rémi Verschelde
d0243e9e0f
Merge pull request #34077 from Calinou/doc-improve-dynamicfont
Improve the DynamicFont class documentation
2019-12-03 10:18:15 +01:00
Rémi Verschelde
dc3d8f0e45
Merge pull request #34076 from Calinou/doc-listener
Add documentation for the Listener class
2019-12-03 10:14:11 +01:00
Hugo Locurcio
673bd79a9e
Improve the DynamicFont class documentation 2019-12-03 09:56:11 +01:00
Hugo Locurcio
c6c5a213cd
Add documentation for the Listener class 2019-12-03 09:38:26 +01:00
Hugo Locurcio
73149499c0
Improve the Camera class documentation
This makes the Camera class 100% documented.
2019-12-03 09:37:01 +01:00
Rémi Verschelde
10bae7c05b
Merge pull request #33857 from nekomatata/polygon-2d-antialiasing
Fixed antialiased option for Polygon2D
2019-12-03 07:51:16 +01:00
Rémi Verschelde
7140d766a2
Merge pull request #33997 from akien-mga/doc-makerst-escape
makerst: Escape default values using reST markup
2019-12-01 11:52:20 +01:00
Aaron Franke
3231fca934
Add docs for is_equal_approx on structures 2019-11-30 16:52:27 -05:00
miere43
d747c61187 Fixed typo in docs for Script and GDScript classes ("exends" -> "extends") 2019-11-30 21:16:11 +03:00
James Westman
7ef16ca136 Docs: GridMap and MeshLibrary
The only methods left to document are resource_changed, set_clip, and
the methods dealing with baked meshes.
2019-11-29 18:21:34 -06:00
Rémi Verschelde
55676b16da makerst: Escape default values using reST markup
Otherwise the docs would complain about values like "godot_"
which reST tries to interpret as an identifier.
2019-11-29 14:25:37 +01:00
PouleyKetchoupp
e6ebc43d72 Fixed antialiased option for Polygon2D / Line2D
Polygon2D:
The property wasn't used anymore after switching from canvas_item_add_polygon() to canvas_item_add_triangle_array() for drawing.

Line2D:
Added the same property as for Polygon2D & fixed smooth line drawing to use indices correctly.

Fixes #26823
2019-11-28 22:57:27 +01:00
Hugo Locurcio
21a3923410
Add an OS.is_window_focused() getter
This makes it possible to know whether the window is focused
at a given time, without having to track the focus state manually
using `NOTIFICATION_WM_FOCUS_IN` and `NOTIFICATION_WM_FOCUS_OUT`.

This partially addresses #33928.
2019-11-28 16:42:51 +01:00
Hugo Locurcio
77d95e3371
Document the ViewportContainer.stretch_shrink property 2019-11-27 16:40:40 +01:00
HaSa1002
5be5f65440 document popup behaviour 2019-11-27 11:47:19 +01:00
Hugo Locurcio
639c9b3a35
Only display Environment sky rotation in degrees in the Inspector
This makes it consistent with Spatial.
2019-11-26 18:57:29 +01:00
Rémi Verschelde
934f6f2529
Merge pull request #33867 from rcorre/get_node_docs
Clarify get_node vs get_node_or_null.
2019-11-25 14:35:45 +01:00
Rémi Verschelde
967cc2c014
Merge pull request #33862 from Faless/net/http_request_chunk_size
Add download_chunk_size property to HTTPRequest.
2019-11-25 14:29:59 +01:00
Fabio Alessandrelli
ed19b4076e Add download_chunk_size property to HTTPRequest.
This allows setting the `read_chunk_size` of the internal HTTPClient.
This is important to reduce the allocation overhead and number of file
writes when downloading large files, allowing for better download speed.
2019-11-24 19:32:20 +01:00
Robert Colton
c99f6453b9
Update Viewport.xml
Add description for gui_is_dragging to document drag and drop behavior.
2019-11-24 10:45:04 -05:00
Rémi Verschelde
ab3bccdb78 Fix typos with codespell
Using codespell 1.16.0.

Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
leapyear
lod
merchantibility
nd
numer
ois
ony
que
seeked
synching
te
uint
unselect
webp
EOF

$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```
2019-11-22 08:35:03 +01:00
Benjamin Navarro
b81f9f777f Better description of the binds parameter of connect
Now states how binds are handled if they are used together with parameters passed to emit_signal
2019-11-21 09:15:58 +01:00
merumelu
94fc676019 Editor: fix typo in VCS plugin method names 2019-11-19 15:11:03 +01:00
Rémi Verschelde
cc025fc8e7
Merge pull request #33663 from Calinou/add-node-get-process-priority
Implement `Node::get_process_priority()` and its associated property
2019-11-17 21:43:28 +01:00
Hugo Locurcio
ae76c62601
Implement Node::get_process_priority() and its associated property
This closes #33660.
2019-11-17 17:48:50 +01:00
Rémi Verschelde
f392c4ea7a
Merge pull request #33658 from NeoSpark314/rename_ext_msaa
Rename External MSAA to AndroidVR MSAA
2019-11-16 22:52:51 +01:00
Holger Dammertz
1b9c2ec92e Rename External MSAA to AndroidVR MSAA
A new external MSAA setting was introduced in https://github.com/godotengine/godot/pull/33518
that fixed issues on GLES2 and Oculus Mobile VR. To avoid misunderstanding it was suggested
by @BastiaanOlij and discussed on discord to rename it to AndroidVR.
2019-11-16 15:36:43 +01:00
willnationsdev
db0082534c Added more in-depth examples of NodePaths in API docs. 2019-11-13 15:14:50 -06:00
Rémi Verschelde
d3a852f124
Merge pull request #33591 from zaksnet/fix-string-docs-split
Fix split/rsplit docs
2019-11-13 14:03:14 +01:00
Zak
79aca6b0c0 Fix split/rsplit docs 2019-11-13 14:58:19 +02:00
Rémi Verschelde
35444576ff
Merge pull request #33576 from merumelu/doc-reload-current-scene
Doc: Add return values for SceneTree::reload_current_scene
2019-11-12 23:17:51 +01:00
IlyaStuurFedorov
fa45fdb5f5 doc: PCKPacker class example code 2019-11-12 23:15:29 +01:00
merumelu
3de002db30 Doc: Add return values for SceneTree::reload_current_scene 2019-11-12 16:43:31 +01:00