Commit graph

2528 commits

Author SHA1 Message Date
Hugo Locurcio
038baede5a
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.
2020-09-23 23:34:28 +02:00
andriyDev
45a1c6f278 Added inspector_only option to inspect_object in EditorInterface.
Updated docs to reflect change to inspect_object.
2020-09-23 13:56:44 -04:00
Rémi Verschelde
7b1de6deda
Merge pull request #42126 from Calinou/doc-videoplayer-formats
Improve documentation about VideoPlayer video formats
2020-09-23 15:40:50 +02:00
Hugo Locurcio
1efe57848a
Improve documentation about VideoPlayer video formats
This closes https://github.com/godotengine/godot-docs/issues/4021.
2020-09-23 14:28:16 +02:00
Rémi Verschelde
c16ef5cb4f
Merge pull request #42181 from Leleat/document-open-open_script_create_dialog
Add description for ScriptEditor.open_script_create_dialog()
2020-09-23 09:31:00 +02:00
Rémi Verschelde
d21b3c2693
Merge pull request #42217 from Calinou/doc-richtextlabel-append-bbcode-no-close
Document `RichTextLabel.append_bbcode()` not closing previously open tags
2020-09-23 08:59:14 +02:00
Rémi Verschelde
94529d0e1e
Merge pull request #41912 from skyace65/NavigationMesh
Document some properties of NavigationMesh
2020-09-22 16:38:27 +02:00
Rémi Verschelde
17b047bd30
Merge pull request #42227 from Calinou/doc-array-fix-typo
Fix a typo in the Array class documentation
2020-09-21 18:43:49 +02:00
Hugo Locurcio
603eddce86
Fix a typo in the Array class documentation
This closes https://github.com/godotengine/godot-docs/issues/4049.
2020-09-21 17:03:14 +02:00
Hugo Locurcio
e9eddb4f1f
Cross-reference AABB and Rect2 in the class reference 2020-09-21 14:27:50 +02:00
Hugo Locurcio
3e1457f517
Document RichTextLabel.append_bbcode() not closing previously open tags
This closes #42216.
2020-09-20 18:21:19 +02:00
Hugo Locurcio
0422027f07
Document that the JavaScript singleton may be disabled at build-time 2020-09-20 16:40:16 +02:00
Leleat
adb205a150 add description for ScriptEditor.open_script_create_dialog() 2020-09-19 00:03:24 +02:00
Rémi Verschelde
3e78963bb9
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 13:44:25 +02:00
bruvzg
6a14c72b12
Add window click-through support. 2020-09-17 12:36:18 +03:00
Hugo Locurcio
9712f8fd2d
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.
2020-09-16 15:53:10 +02:00
skyace65
75adefd4b6 Add documentation for shelf filters 2020-09-15 09:34:12 -04:00
Hugo Locurcio
f83249f224
Clarify that 2D cell sizes are defined in pixels
See https://github.com/godotengine/godot/issues/40577#issuecomment-662329021.
2020-09-15 14:06:42 +02:00
Yuri Roubinsky
f137f14e1c Renames Type to OpType in VisualShaderNodeMultiplyAdd
To prevent possible conflicts with C# and other languages.
2020-09-15 11:06:18 +03:00
Danil Alexeev
a4c5790350 Several documentation improvements 2020-09-14 20:02:19 +03:00
Rémi Verschelde
c5f7a581f7
Merge pull request #42036 from Calinou/doc-object-metadata-remove
Document how to remove metadata from an Object
2020-09-14 14:22:15 +02:00
Hugo Locurcio
cba4d73b71
Document how to remove metadata from an Object
This closes https://github.com/godotengine/godot-docs/issues/4010.
2020-09-14 14:01:13 +02:00
Rémi Verschelde
8818a93a3c
Merge pull request #41987 from skyace65/Audio1
Improve AudioEffectDistortion and AudioEffectFilter documentation
2020-09-14 09:23:04 +02:00
Hugo Locurcio
52d77b6928
Update and complete the Sprite3D and SpriteBase3D class documentations
This removes an outdated notice about Sprite3D performance issues
which will most likely be fixed in the new implementation.
2020-09-12 15:43:01 +02:00
skyace65
959f2287f6 Improve AudioEffectDistortion and AudioEffectFilter documentation 2020-09-11 11:34:23 -04:00
Ebrahim Ebrahim
b9764b6109 Clarify get_data Image method 2020-09-11 11:10:18 -04:00
Rémi Verschelde
a2a78a8066
doc: Sync classref with current source
Bind missing enums.
2020-09-11 12:22:10 +02:00
Rémi Verschelde
d782405bcf
Merge pull request #41957 from skyace65/SpriteFrames
Improve SpriteFrames get_animation_loop description
2020-09-10 21:22:00 +02:00
skyace65
d311c48d6a Improve SpriteFrames get_animation_loop description 2020-09-10 15:08:42 -04:00
Rémi Verschelde
0819657c3b
Merge pull request #41954 from Calinou/raycast-rename-cast-to
Rename RayCast's `cast_to` property to `target_position`
2020-09-10 19:19:59 +02:00
Hugo Locurcio
a706c22db7
Rename RayCast's cast_to property to target_position
`cast_to` is sometimes mistaken as a method rather than a property.
`target_position` makes it more obvious that it's a property.
2020-09-10 19:06:56 +02:00
Rémi Verschelde
1d70912080
Merge pull request #41890 from YeldhamDev/tabs_previous
Add 'get_previous_tab()' to 'Tabs'
2020-09-10 11:20:11 +02:00
Yuri Roubinsky
5ba8246cfb Added Texture3D to visual shaders 2020-09-10 07:40:06 +03:00
Hugo Locurcio
3e0226515e
Rename ShortCut to Shortcut which is more grammatically correct
See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980.
2020-09-09 21:54:54 +02:00
skyace65
496a2f17bd Document some properties of NavigationMesh 2020-09-09 10:21:18 -04:00
Hugo Locurcio
263f620421
Improve documentation related to Array error handling
This closes https://github.com/godotengine/godot-docs/issues/3834.
2020-09-09 14:57:02 +02:00
Michael Alexsander
2b319889cb Add 'get_previous_tab()' to 'Tabs' 2020-09-08 17:35:49 -03:00
Rémi Verschelde
3c42d5789f
Merge pull request #38308 from bruvzg/sad_security_circus
Adds PCK encryption support (using script encryption key for export).
2020-09-07 17:12:01 +02:00
Fabio Alessandrelli
2cb6b2ac6f
Merge pull request #38944 from Wavesonics/http-gzip
HttpRequest now handles gzipping response bodies
2020-09-07 17:03:19 +02:00
Hugo Locurcio
40b5331d79
Clarify the required child node type in the GridContainer documentation
This closes #41822.
2020-09-07 01:41:08 +02:00
Yuri Roubinsky
de097b9327 Removes redundant code & fix documentation for VisualShaderNodeCustom 2020-09-06 12:09:15 +03:00
bruvzg
f043eabdd8
Adds PCK encryption support (using script encryption key for export).
Change default encryption mode from ECB to CFB.
2020-09-05 14:53:39 +03:00
Rémi Verschelde
de284f931d
doc: Sync classref with current source 2020-09-04 10:43:11 +02:00
bruvzg
80b8eff6aa
[Complex Test Layouts] Change String to use UTF-32 encoding on all platforms. 2020-09-03 19:56:24 +03:00
Rémi Verschelde
0864f12f0d
Merge pull request #41044 from hoontee/master-4
Implement CollisionShape3D.make_convex_from_siblings()
2020-09-03 16:29:08 +02:00
Rémi Verschelde
fd51d022c1
Merge pull request #41714 from Yetizone/sub_viewport_clear_mode_doc
Mention SubViewport.render_target_clear_mode property is intended for 2D usage
2020-09-03 08:01:09 +02:00
Rémi Verschelde
4a5138bb99
Merge pull request #40400 from Arivval/load-resourcepack-with-offset
Added PCK file loading with offset feature
2020-09-03 07:33:19 +02:00
Yetizone
3866d237e5 Mention SubViewport.render_target_clear_mode property is intended for 2D usage. 2020-09-03 08:10:16 +03:00
Yilin Ma
c524d50444 added load resource pack with offset feature
updated variables to use size_t

removed line break to make code style more consistent

added conditional check to return an error if offset field is used when loading a ZIP package

fixed typo

formatted file

added commit regarding self contained exe files

handled error loging for load zip file with offset

spelling tweak

updated conditional statement for magic check

udpated error message when load Zip file with offset is called

fix CI

Trying to fix CI

fix CI done

Added error message for loading self-contained exe with offset.

Updated documentation.

Fix indent

final fix indent

Updated documentation.

fix indents

Updated doc based on suggestion

Final fix

fixed format
2020-09-02 17:57:01 -05:00
Adam Brown
6584db1538 HTTPRequest now accepts gzip
Added request_raw to HttpRequest
Added decompress_dynamic to Compression class
Added decompress_dynamic to BytePoolArray

Merge doc fix

revert
2020-09-02 12:59:59 -07:00
Eric M
926c282fd5 Updated PopupMenu documentation after merge of #41640 - PopupMenu rework 2020-09-02 10:19:57 +10:00
Rémi Verschelde
d70a17d5d3
Merge pull request #40408 from Calinou/doc-font-missing-character
Document missing character behavior when drawing text with fonts
2020-09-01 23:48:45 +02:00
Rémi Verschelde
23ce1dbfd5
Merge pull request #41668 from clayjohn/GLOW-HQ
Add high quality glow mode
2020-09-01 21:04:07 +02:00
Rémi Verschelde
c55df5c016
Merge pull request #41659 from umarcor/doc/FileDialog/warning-sandbox
doc/FileDialog: warn about access limitations in sandboxed apps
2020-09-01 20:55:19 +02:00
Rémi Verschelde
f8720c85ca
Merge pull request #41679 from Calinou/doc-projectsettings-name-user-data
Document how renaming the project affects the user data path
2020-09-01 20:25:45 +02:00
Rémi Verschelde
e143488d06
Merge pull request #41641 from skyace65/TextEdit
Document scroll horizontal and scroll vertical in text edit
2020-09-01 19:50:44 +02:00
Rémi Verschelde
52013cdee3
Merge pull request #41677 from Calinou/doc-rigidbody-sleeping
Document RigidBodies in character mode never sleeping automatically
2020-09-01 19:48:42 +02:00
Rémi Verschelde
cb5db91cf0
Merge pull request #40269 from Calinou/doc-animatedsprite2d-normal-specular
Document support for normal and specular maps in AnimatedSprite2D
2020-09-01 19:47:56 +02:00
Hugo Locurcio
386f86cddf
Document how renaming the project affects the user data path 2020-09-01 19:19:25 +02:00
Hugo Locurcio
5fbf709ca2
Document RigidBodies in character mode never sleeping automatically
See #7996.
2020-09-01 18:54:13 +02:00
umarcor
1ddb0e56ac doc/FileDialog: warn about access limitations in sandboxed apps
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-09-01 16:22:15 +02:00
skyace65
eb8fe8b084 Document scroll horizontal and scroll vertical in text edit 2020-09-01 10:13:54 -04:00
Hugo Locurcio
7735d8d0ce
Document missing character behavior when drawing text with fonts
See #40405.
2020-09-01 14:36:16 +02:00
Rémi Verschelde
877246a78e
Merge pull request #41505 from SekoiaTree/neg-get-child
Made get_child support negative indexes
2020-09-01 12:35:55 +02:00
SekoiaTree
bdf614d3d7 Made get_child support negative indexes, with documentation 2020-09-01 11:34:36 +02:00
clayjohn
8da3c739bf Add high quality glow mode 2020-08-31 23:16:41 -07:00
Aaron Franke
ecd6a893b4
Change Color HTML conversion from ARGB to RGBA
Also add support for 3 and 4 digit values in C#. Now it actually matches the HTML/CSS spec.
2020-09-01 02:07:35 -04:00
Rémi Verschelde
2cfc5b8680
Merge pull request #40993 from Calinou/doc-collision-layer-mask
Reference the online documentation in collision layer/mask properties
2020-08-31 15:32:44 +02:00
Rémi Verschelde
0b4a325ddc
Merge pull request #41048 from Calinou/doc-add-link-titles
Add link titles for all links in the class reference
2020-08-31 15:32:19 +02:00
Jonathan Vice
28326aec60 Reorder sprite h_frames & v_frames 2020-08-31 14:55:49 +02:00
Hugo Locurcio
ecc47ce235
Document the BaseMaterial3D billboard mode not being suited for VR
See #41567.
2020-08-31 14:24:43 +02:00
Hugo Locurcio
c4903a603b
Add link titles for all links in the class reference
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
Rémi Verschelde
bb724ffd02
Merge pull request #41602 from Andy0903/option-button-signal-word-order-fix
OptionButton.xml word order fix
2020-08-31 13:27:09 +02:00
Rémi Verschelde
fbb2e60783
Merge pull request #41457 from KoBeWi/ca
Explain editor usage of current_animation
2020-08-31 13:24:37 +02:00
Rémi Verschelde
df333bcc66
Merge pull request #41012 from mrushyendra/cursor_open
Updated cursor positioning description for File open()
2020-08-31 13:22:35 +02:00
Rémi Verschelde
6ebe68554c
Merge pull request #40998 from Calinou/doc-httprequest-get-request-data
Document HTTPRequest not supporting request data with GET method
2020-08-31 13:21:38 +02:00
Rémi Verschelde
9ae5f998e7
Merge pull request #41018 from Calinou/doc-theme-constants
Improve the documentation related to overriding GUI theme items
2020-08-31 13:13:32 +02:00
Rémi Verschelde
1137d2b5dc
Merge pull request #41645 from akien-mga/classref
doc: Sync classref with current source
2020-08-31 12:52:53 +02:00
Rémi Verschelde
ccf3c2d0e1
Merge pull request #41077 from Calinou/doc-find-node-find-parent
Mention performance caveats about `find_node()` and `find_parent()`
2020-08-31 12:52:36 +02:00
Rémi Verschelde
ee03e39da7
doc: Sync classref with current source 2020-08-31 11:25:11 +02:00
Rémi Verschelde
a0b95e5d9c
Merge pull request #41638 from skyace65/Texture
Clarify get_data texture method
2020-08-31 11:17:47 +02:00
Rémi Verschelde
a276e6fc36
Merge pull request #40955 from Calinou/test-add-expression
Add a test suite for Expression
2020-08-31 11:12:34 +02:00
skyace65
635c9761a0 Clarify get_data texture method 2020-08-30 21:47:28 -04:00
Hugo Locurcio
ab2f41f598
Mention performance caveats about find_node() and find_parent()
See https://github.com/godotengine/godot-proposals/issues/1303.
2020-08-29 21:36:57 +02:00
Tomasz Chabora
70ce86ad29 Explain editor usage of current_animation 2020-08-29 19:27:03 +02:00
Andreas Gustafsson
8f082d63c6 OptionButton.xml word order fix
Change word order of 'Emitted the when...' into 'Emitted when the...'
2020-08-29 17:21:00 +02:00
Rémi Verschelde
6ae83b64ef
Merge pull request #41521 from Calinou/doc-accelerometer-platforms
Document supported platforms for `Input.get_accelerometer()` and related
2020-08-29 13:04:20 +02:00
Rémi Verschelde
7d6c5c90b5
Merge pull request #41350 from skyace65/tilemap
Add defaults to tilemap set_cell function example
2020-08-29 12:53:22 +02:00
Hugo Locurcio
dec20883c1
Document the GDScript debugger not supporting Thread yet
See https://github.com/godotengine/godot/issues/2446.
2020-08-29 02:24:07 +02:00
Hugo Locurcio
eee704e6f6
Document supported platforms for Input.get_accelerometer() and related
This closes #41303.
2020-08-29 02:16:43 +02:00
Rémi Verschelde
5abb53be68
Merge pull request #41441 from YeldhamDev/input_docs_mouse_capture
State how 'MOUSE_MODE_CAPTURED' actually works in the 'Input' docs
2020-08-28 23:30:08 +02:00
Rémi Verschelde
61e6cec02e
Merge pull request #41507 from skyace65/AudioListener
Mention listener node in AudioStreamPlayer3D description
2020-08-28 23:28:44 +02:00
Michael Alexsander
4f13a7f47f State how 'MOUSE_MODE_CAPTURED' actually works in the 'Input' docs 2020-08-28 17:19:19 -03:00
Hugo Locurcio
359c95156a
Clarify that KEY_BACK is unrelated to the Back button on Android
This closes #19325.
2020-08-28 17:10:08 +02:00
Rémi Verschelde
a258180723
Merge pull request #41573 from skyace65/Thread
Add information to get thread id
2020-08-28 10:46:16 +02:00
Rémi Verschelde
2b36a999fa
Merge pull request #41566 from skyace65/TouchScreenButton
Improve touch screen button description
2020-08-28 10:46:02 +02:00
skyace65
aa08023115 Add information to get thread id 2020-08-27 22:11:35 -04:00
skyace65
416cac96fa Improve touch screen button description 2020-08-27 16:48:07 -04:00
skyace65
51367c1bcf Mention listener node in AudioStreamPlayer3D description 2020-08-27 12:44:20 -04:00
skyace65
555f4f3e17 Document where the center of mass is for RigidBody nodes 2020-08-27 11:20:29 -04:00