Commit graph

2493 commits

Author SHA1 Message Date
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
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
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