Commit Graph

2556 Commits

Author SHA1 Message Date
Duroxxigar 85a8dbb7b6 Made toplevel a property for Node3D and CanvasItem 2020-10-01 02:43:30 -04:00
Andrii Doroshenko (Xrayez) a8404cf56c Cross-reference GDScript `load` and `ResourceLoader.load` in classref
The GDScript `load` mention is moved from the class `ResourceLoader`
description to the `ResourceLoader.load` method description instead,
where it is more likely to be found.
2020-09-30 23:03:36 +03:00
Hugo Locurcio 00ade39389
Improve the `String.is_valid_ip_address()` documentation
This closes https://github.com/godotengine/godot-docs/issues/4097.
2020-09-30 19:26:14 +02:00
Hugo Locurcio a2271ba3bd
Improve the String comparison methods' documentation
This closes https://github.com/godotengine/godot-docs/issues/4096.
2020-09-30 19:08:20 +02:00
Wilson E. Alvarez b4e7edabf3
Make "function" a property of FuncRef 2020-09-30 06:57:59 -04:00
Rémi Verschelde 8c72b15e51
Merge pull request #38579 from Megamega53/edit
doc: Some improvements to KinematicBody docs
2020-09-29 11:13:10 +02:00
Rémi Verschelde 1bd2efdd46
Merge pull request #38683 from follower/patch-11
Improve doc clarity/detail for extra spacing properties
2020-09-29 10:57:19 +02:00
Rémi Verschelde 7f72d92cb0
Merge pull request #36067 from jsl118/distancefadefix
doc: Improve distance_fade documentation
2020-09-29 10:42:34 +02:00
Rémi Verschelde bebf424c80
Merge pull request #42078 from Chaosus/vs_rename_type
Renames Type to OpType in VisualShaderNodeMultiplyAdd
2020-09-29 10:34:22 +02:00
Justin Lee 90d1eda90e
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>
2020-09-29 10:21:50 +02:00
Megamega53 ca5ae64525
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>
2020-09-29 10:14:56 +02:00
follower 2ef89e0b43 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.
2020-09-29 10:04:46 +02:00
Rémi Verschelde 2d14c7cb69
Merge pull request #42125 from andriyDev/inspector_only_option
Added inspector_only option to inspect_object in EditorInterface.
2020-09-29 08:45:38 +02:00
Aaron Franke 5fbcd8f9df
Rename the ".import" folder to ".godot/imported" 2020-09-28 05:23:45 -04:00
Rémi Verschelde 64d3827b19
Merge pull request #41579 from Calinou/doc-basematerial3d-billboard-mode
Document the BaseMaterial3D billboard mode not being suited for VR
2020-09-28 10:40:09 +02:00
Rémi Verschelde 1a8dfcd97b
Merge pull request #42304 from akien-mga/os-drop-get_splash_tick_msec
OS: Remove unused get_splash_tick_msec
2020-09-28 10:13:37 +02:00
Nathan Lovato 173b9e6be7 Remove link to step-by-step/animations
Required for godotengine/godot-docs#4074 to pass, we're removing that
page from the docs as part of the getting started section rewrite.
2020-09-27 10:20:27 -06:00
Rémi Verschelde 68e4454c31
Merge pull request #41960 from Calinou/doc-sprite3d
Update and complete the Sprite3D and SpriteBase3D class documentations
2020-09-27 08:44:25 +02:00
Rémi Verschelde c844cc8251
Merge pull request #42016 from HaSa1002/docs-lang-2
Translate GDScript Code Examples to C# (Classes beginning with C)
2020-09-26 23:36:16 +02:00
HaSa1002 c5aded55df Add C# code examples to the docs
Only existing GDScript code examples are converted and added to the
docs.
This is the first batch include classes beginning with A and B.

Included classes:
 * AcceptDialog
 * AESContext
 * Animation
 * AnimationNodeStateMachine
 * AnimationNodeStateMachinePlayback
 * AnimationNodeStateMachineTransition
 * Array
 * ArrayMesh
 * AStar
 * AStar2D
 * Bool
 * Button
2020-09-26 12:29:55 +02:00
HaSa1002 ae873ab822 Translate GDScript Code Examples to C# (C)
Translates Code Examples in classes beginning with `C`.

Includes:
 * Callable
 * CanvasItem
 * CharFXTransform
 * Color
 * ColorRect
 * ConfigFile
 * ConfirmationDialog
 * Control
 * Crypto
2020-09-26 11:48:37 +02:00
Haoyu Qiu aa7ce12bee Surrounds boolean false with code tag 2020-09-25 00:00:22 +08:00
Rémi Verschelde f21b32aa04
Merge pull request #41683 from skyace65/File
Move note about using ResourceLoader in the File documentation
2020-09-24 17:05:49 +02:00
skyace65 75c5a8b354 Move note about using Resource in the File documentation 2020-09-24 10:37:03 -04:00
Rémi Verschelde 819c3524a5
OS: Remove unused get_splash_tick_msec
It was added in 3e20391bf6 but it doesn't seem
particularly useful, and it was only implemented for the custom splash branch
and not the default one, so it could return an uninitialized int.
2020-09-24 15:40:30 +02:00
Rémi Verschelde a5885d6987
Merge pull request #42089 from skyace65/ShelfFilters
Add documentation for shelf filters
2020-09-24 15:16:04 +02:00
Rémi Verschelde 079b6753c3
Merge pull request #42287 from Calinou/doc-color-constants-cheatsheet
Reference the Color constants cheatsheet in the class reference
2020-09-24 15:13:52 +02:00
Hugo Locurcio de49085567
Reference the Color constants cheatsheet in the class reference 2020-09-23 23:48:37 +02:00
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