Commit graph

2161 commits

Author SHA1 Message Date
Ryan Roden-Corrent
35d58c4435
Clarify store_string vs store_line.
While the behavior can be implied from the name, it seems worth stating
it explicitly.

(cherry picked from commit 2762821c08)
2020-10-01 16:00:47 +02:00
Duroxxigar
a726d011d5
Made toplevel a property for Node3D and CanvasItem
(cherry picked from commit 85a8dbb7b6)
2020-10-01 16:00:47 +02:00
Hugo Locurcio
016ea497eb
Improve the String.is_valid_ip_address() documentation
This closes https://github.com/godotengine/godot-docs/issues/4097.

(cherry picked from commit 00ade39389)
2020-10-01 16:00:47 +02:00
Hugo Locurcio
867b0d57d6
Improve the String comparison methods' documentation
This closes https://github.com/godotengine/godot-docs/issues/4096.

(cherry picked from commit a2271ba3bd)
2020-10-01 16:00:47 +02:00
Wilson E. Alvarez
5766547e33
Make "function" a property of FuncRef
(cherry picked from commit b4e7edabf3)
2020-10-01 16:00:47 +02:00
Rémi Verschelde
4ad74609ce
Merge pull request #40205 from bruvzg/click-through-3
[3.2] Add mouse event pass-through support for window.
2020-10-01 13:58:24 +02:00
Rémi Verschelde
ef223f3aa7
Merge pull request #41185 from Chaosus/vs_uniform_ref_3.2
[3.2] Added UniformRef visual shader node
2020-10-01 13:50:08 +02:00
Sergey Minakov
42de81e235 iOS: move touch delay to settings 2020-10-01 12:36:57 +03:00
Rémi Verschelde
66cbcc1b7e
Merge pull request #41123 from lawnjelly/octree_fix
Optimize octree and fix leak
2020-09-30 23:11:31 +02:00
Rémi Verschelde
aaf0b32e91
doc: Sync classref with current source 2020-09-29 13:57:58 +02:00
follower
0d8cbd5d8c
Doc clarity/detail for extra spacing properties
Re: Space spacing being in addition to character spacing see:

 * <d7b85fbaa1/scene/resources/dynamic_font.cpp (L858-L859)>

Re: Value being able to be negative see example here:

 * <https://github.com/godotengine/godot/issues/38630>

But also note that nodes other than `Label` may not currently render extra space spacing correctly.

(cherry picked from commit 2ef89e0b43)
2020-09-29 13:57:58 +02:00
Megamega53
6bfaa8a8c9
doc: Some improvements to KinematicBody docs
Co-authored-by: Marcel Admiraal <madmiraal@users.noreply.github.com>
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
(cherry picked from commit ca5ae64525)
2020-09-29 13:57:58 +02:00
Justin Lee
52b3324e58
doc: Improve distance_fade documentation
Changed the documentation of distance_fade_max_distance and min
to be consistent with the behavior of the code as well as the user
documentation. Also noted the behavior of swapping max_distance and
min_distance (where max_distance < min_distance).

Fixes #36051.

Co-authored-by: Clay John <claynjohn@gmail.com>
(cherry picked from commit 90d1eda90e)
2020-09-29 13:57:58 +02:00
andriyDev
98eb6e4af6
Added inspector_only option to inspect_object in EditorInterface.
Updated docs to reflect change to inspect_object.

(cherry picked from commit 45a1c6f278)
2020-09-29 13:57:57 +02:00
Hugo Locurcio
00e4be1926
Document the BaseMaterial3D billboard mode not being suited for VR
See #41567.

(cherry picked from commit ecc47ce235)
2020-09-29 13:57:57 +02:00
Haoyu Qiu
9bf09a909b
Surrounds boolean false with code tag
(cherry picked from commit aa7ce12bee)
2020-09-29 13:57:56 +02:00
skyace65
a2c4564dc3
Move note about using Resource in the File documentation
(cherry picked from commit 75c5a8b354)
2020-09-29 08:54:45 +02:00
skyace65
1257beac96
Add documentation for shelf filters
(cherry picked from commit 75adefd4b6)
2020-09-29 08:54:44 +02:00
Hugo Locurcio
28be48fb67
Reference the Color constants cheatsheet in the class reference
(cherry picked from commit de49085567)
2020-09-29 08:54:44 +02:00
Hugo Locurcio
c33373b80a
Reference the BaseButton class explicitly in button class documentations
Users are sometimes confused as to the `pressed` property not being
visible in the Button class documentation. This is because `pressed`
is defined in BaseButton.

(cherry picked from commit 038baede5a)
2020-09-24 14:43:12 +02:00
Hugo Locurcio
6036fdab70
Cross-reference AABB and Rect2 in the class reference
(cherry picked from commit e9eddb4f1f)
2020-09-24 14:43:12 +02:00
Hugo Locurcio
f568413e8d
Document RichTextLabel.append_bbcode() not closing previously open tags
This closes #42216.

(cherry picked from commit 3e1457f517)
2020-09-24 14:43:11 +02:00
Hugo Locurcio
575aa3efe3
Document that the JavaScript singleton may be disabled at build-time
(cherry picked from commit 0422027f07)
2020-09-24 14:43:11 +02:00
Leleat
27b09083fc
add description for ScriptEditor.open_script_create_dialog()
(cherry picked from commit adb205a150)
2020-09-24 14:43:11 +02:00
Hugo Locurcio
92a85b4445
Improve documentation about VideoPlayer video formats
This closes https://github.com/godotengine/godot-docs/issues/4021.

(cherry picked from commit 1efe57848a)
2020-09-24 14:43:11 +02:00
Michael Alexsander
2d848227cf
Add 'get_previous_tab()' to 'Tabs'
(cherry picked from commit 2b319889cb)
2020-09-24 14:43:10 +02:00
Jonathan Vice
96ca267209
Reorder sprite h_frames & v_frames
(cherry picked from commit 28326aec60)
2020-09-24 14:43:10 +02:00
Yilin Ma
d571de5f81
added load resource pack with offset feature
(cherry picked from commit c524d50444)
2020-09-24 14:43:09 +02:00
Hugo Locurcio
e07ac3d77e
Fix a typo in the Array class documentation
This closes https://github.com/godotengine/godot-docs/issues/4049.

(cherry picked from commit 603eddce86)
2020-09-24 14:43:07 +02:00
Somnath Sarkar
1f7a3e0f8d
Sort points in a Gradient for color and offset updates.
(cherry picked from commit d5d832417e)
2020-09-24 14:43:06 +02:00
Aaron Franke
76a8458753
Make the Import dock depend on the FileSystem dock
(cherry picked from commit de6f8f9d21)
2020-09-24 14:43:05 +02:00
Rémi Verschelde
c8859f0463
Fix typos with codespell
Using codespell 1.17.1.

Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
fave
findn
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
```
2020-09-18 14:09:51 +02:00
bruvzg
e51fed9d1b
[3.2] Add window click-through support. 2020-09-17 12:36:01 +03:00
Hugo Locurcio
939de03db7
Cross-reference AABB getter methods in the documentation
This also clarifies that `get_aabb()` returns the AABB in local space.

See https://github.com/godotengine/godot/issues/42095.

(cherry picked from commit 9712f8fd2d)
2020-09-16 16:22:39 +02:00
Hugo Locurcio
369e5a7f35
Mark InterpolatedCamera as deprecated
InterpolatedCamera has already been removed from the `master` branch.
This adds a deprecation notice to inform people about the upcoming removal
in Godot 4.0.

Its functionality could be replicated in a GDScript add-on with relative
ease.
2020-09-16 15:36:40 +02:00
Rémi Verschelde
16eb7b95be
Merge pull request #42102 from Calinou/doc-animationtreeplayer-deprecation
Mention the AnimationTreePlayer deprecation in the class reference
2020-09-16 08:13:27 +02:00
Hugo Locurcio
868776949b
Mention the AnimationTreePlayer deprecation in the class reference
There's a node configuration warning already, but you can only
see it after adding the node to your scene.
2020-09-16 00:19:32 +02:00
Hugo Locurcio
34a0af8343
Clarify that 2D cell sizes are defined in pixels
See https://github.com/godotengine/godot/issues/40577#issuecomment-662329021.

(cherry picked from commit f83249f224)
2020-09-15 19:26:43 +02:00
Danil Alexeev
06f3cd8bd8
Several documentation improvements
(cherry picked from commit a4c5790350)
2020-09-15 19:26:40 +02:00
Hugo Locurcio
738f6ea221
Document how to remove metadata from an Object
This closes https://github.com/godotengine/godot-docs/issues/4010.

(cherry picked from commit cba4d73b71)
2020-09-14 14:24:14 +02:00
Ebrahim Ebrahim
508dde662a
Clarify get_data Image method
(cherry picked from commit b9764b6109)
2020-09-14 11:00:50 +02:00
skyace65
de9a5b6229
Improve AudioEffectDistortion and AudioEffectFilter documentation
(cherry picked from commit 959f2287f6)
2020-09-14 11:00:49 +02:00
Hugo Locurcio
74952764f3
Improve documentation related to Array error handling
This closes https://github.com/godotengine/godot-docs/issues/3834.

(cherry picked from commit 263f620421)
2020-09-10 12:04:07 +02:00
Hugo Locurcio
2bc6298bce
Document that batching is only effective when using the GLES2 renderer 2020-09-09 00:58:25 +02:00
Rémi Verschelde
4a9264271d
doc: Sync classref with current source 2020-09-08 14:20:53 +02:00
Hugo Locurcio
77a6766b3e
Clarify the required child node type in the GridContainer documentation
This closes #41822.

(cherry picked from commit 40b5331d79)
2020-09-08 08:56:13 +02:00
Hugo Locurcio
c040e8f93a Document missing character behavior when drawing text with fonts
See #40405.

(cherry picked from commit 7735d8d0ce)
2020-09-04 08:50:32 +02:00
Yetizone
e882d535a7 Mention Viewport.render_target_clear_mode property is intended for 2D usage 2020-09-03 07:57:01 +03:00
Hugo Locurcio
d773de6d24
Document how renaming the project affects the user data path
(cherry picked from commit 386f86cddf)
2020-09-01 21:02:19 +02:00
Hugo Locurcio
be126bfd55
Document RigidBodies in character mode never sleeping automatically
See #7996.

(cherry picked from commit 5fbf709ca2)
2020-09-01 21:01:58 +02:00