Commit Graph

2485 Commits

Author SHA1 Message Date
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
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
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
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
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
aa7ce12bee Surrounds boolean false with code tag 2020-09-25 00:00:22 +08:00
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
75c5a8b354 Move note about using Resource in the File documentation 2020-09-24 10:37:03 -04:00
a5885d6987 Merge pull request #42089 from skyace65/ShelfFilters
Add documentation for shelf filters
2020-09-24 15:16:04 +02:00
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
de49085567 Reference the Color constants cheatsheet in the class reference 2020-09-23 23:48:37 +02:00
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
7b1de6deda Merge pull request #42126 from Calinou/doc-videoplayer-formats
Improve documentation about VideoPlayer video formats
2020-09-23 15:40:50 +02:00
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
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
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
94529d0e1e Merge pull request #41912 from skyace65/NavigationMesh
Document some properties of NavigationMesh
2020-09-22 16:38:27 +02:00
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
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
e9eddb4f1f Cross-reference AABB and Rect2 in the class reference 2020-09-21 14:27:50 +02:00
3e1457f517 Document RichTextLabel.append_bbcode() not closing previously open tags
This closes #42216.
2020-09-20 18:21:19 +02:00
0422027f07 Document that the JavaScript singleton may be disabled at build-time 2020-09-20 16:40:16 +02:00
adb205a150 add description for ScriptEditor.open_script_create_dialog() 2020-09-19 00:03:24 +02:00
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
6a14c72b12 Add window click-through support. 2020-09-17 12:36:18 +03:00
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
75adefd4b6 Add documentation for shelf filters 2020-09-15 09:34:12 -04:00
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
a4c5790350 Several documentation improvements 2020-09-14 20:02:19 +03:00
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
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
8818a93a3c Merge pull request #41987 from skyace65/Audio1
Improve AudioEffectDistortion and AudioEffectFilter documentation
2020-09-14 09:23:04 +02:00
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
959f2287f6 Improve AudioEffectDistortion and AudioEffectFilter documentation 2020-09-11 11:34:23 -04:00
b9764b6109 Clarify get_data Image method 2020-09-11 11:10:18 -04:00
a2a78a8066 doc: Sync classref with current source
Bind missing enums.
2020-09-11 12:22:10 +02:00
d782405bcf Merge pull request #41957 from skyace65/SpriteFrames
Improve SpriteFrames get_animation_loop description
2020-09-10 21:22:00 +02:00
d311c48d6a Improve SpriteFrames get_animation_loop description 2020-09-10 15:08:42 -04:00
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
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
1d70912080 Merge pull request #41890 from YeldhamDev/tabs_previous
Add 'get_previous_tab()' to 'Tabs'
2020-09-10 11:20:11 +02:00
5ba8246cfb Added Texture3D to visual shaders 2020-09-10 07:40:06 +03:00
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
496a2f17bd Document some properties of NavigationMesh 2020-09-09 10:21:18 -04:00
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
2b319889cb Add 'get_previous_tab()' to 'Tabs' 2020-09-08 17:35:49 -03:00
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
2cb6b2ac6f Merge pull request #38944 from Wavesonics/http-gzip
HttpRequest now handles gzipping response bodies
2020-09-07 17:03:19 +02:00
40b5331d79 Clarify the required child node type in the GridContainer documentation
This closes #41822.
2020-09-07 01:41:08 +02:00
de097b9327 Removes redundant code & fix documentation for VisualShaderNodeCustom 2020-09-06 12:09:15 +03:00