Commit graph

1800 commits

Author SHA1 Message Date
Michael Alexsander
c4745c96d7 Remove unnecessary extra spaces before comments in code examples. 2020-01-23 14:41:49 -03:00
clayjohn
6b66957b85 Finish documenting CSG* and *probes 2020-01-23 13:54:17 +01:00
Rémi Verschelde
ba177ccaec doc: Misc updates for AnimationNode* and others
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
  * Make `AnimationNodeTransition.input_<number>` properties internal
    so that they don't appear in the docs. They still appear in the
    inspector based on the actual number of inputs requested.
  * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
    particles in `ParticlesMaterial`, and thus only relevant for
    `CPUParticles3D`.
2020-01-23 12:37:33 +01:00
Hugo Locurcio
90a1f8d8a7
Make OS.execute() blocking by default if not specified
This makes `OS.execute()` calls quicker to set up when calling programs
in a blocking fashion.
2020-01-23 01:26:32 +01:00
Bojidar Marinov
b4770c0a27
Add settings from SceneTree in the documentation
Fixes #35439
2020-01-22 22:37:56 +02:00
Bojidar Marinov
387ee7d763
Get real default values for project settings in documentation
Also, ignore custom project settings and values for input/ entries

Fixes #34154
2020-01-22 15:57:10 +02:00
Rémi Verschelde
829d21f1c2
Merge pull request #35352 from Feniks-Gaming/BetterDictionary
Improve dictionary description
2020-01-22 13:20:41 +01:00
Rémi Verschelde
de543d18e8
Merge pull request #35389 from clayjohn/DOCS-materials
Finish up docs for materials
2020-01-22 07:41:33 +01:00
clayjohn
f2ece82480 Finish up docs for materials 2020-01-21 19:28:32 -08:00
Rémi Verschelde
1508cc4051
Merge pull request #35363 from ericrybick/33106-importing-textureAtlas-cuts-out-the-sprites
Fix AtlasPacker ignoring semi-transparent pixels
2020-01-21 00:13:12 +01:00
Eric Rybicki
439e0027ec Fix AtlasPacker ignoring semi-transparent pixels
Fixes #33106
2020-01-20 22:43:38 +01:00
Feniks
6e24933115 Improve dictionary description
I improved dictionary description to ad some real life examples and expand on it a little bit so person who never seen dictionary can understand it better seeing them for a first time here. 
I also added note about the way to compare dictionaries  as it can catch people of guard because common assumption is that it works the same as comparing Arrays when it does not.
2020-01-20 20:36:59 +00:00
Rémi Verschelde
837adb30fd Revert "Exposes capture methods to AudioServer + documentation" #30468
Reverts the following commits:

- c81ec6f26d:
  "Exposes capture methods to AudioServer, variable renames for
  consistency, added documentation."
- 47c558b98a:
  "Expose audio callbacks as signals."
- dabaa11b3c:
  "Fix to make sure the capture buffers are deallocated at shutdown.
  Silences warnings."

Some documentation improvements were kept for pre-existing methods.

See rationale for reverting these changes in #30468.
2020-01-20 13:18:01 +01:00
Rémi Verschelde
adb6734b49 doc: Sync classref with current source 2020-01-19 23:19:29 +01:00
Rémi Verschelde
62d656ea06
Merge pull request #35327 from KoBeWi/globalization
Mention that KinematicCollisions use global coords
2020-01-19 22:25:10 +01:00
Rémi Verschelde
cb088e391e
Merge pull request #35300 from Feniks-Gaming/GraphNodeDesc
Improve Description of GraphNode
2020-01-19 22:19:41 +01:00
Tomasz Chabora
5a75c4a840 Mention that KinematicCollisions use global coords 2020-01-19 20:22:31 +01:00
Feniks
1ebf4c7fdc Improve Description of GraphNode
It mostly fixes issues I have listed in https://github.com/godotengine/godot-docs/issues/3065 where GraphNode description was rather lacking clarity. It was near impossible how to use the them or how to create new slots etc. 

I improved it quite a bit if anyone has idea how to reword original "A tuple of input and output slots is defined for each GUI element included in the GraphNode." I would love to hear it. I am unsure how to word it in more understandable way.
2020-01-19 19:21:30 +00:00
Rémi Verschelde
05c8654390 doc: Timer.autostart resets to false on start
Fixes #35289.
2020-01-19 10:18:11 +01:00
Rémi Verschelde
d4a222cd9d
Merge pull request #35281 from timothyqiu/video-player-doc
Improves VideoPlayer's documentation
2020-01-18 15:27:28 +01:00
Haoyu Qiu
ecf3d3fd84 Improves VideoPlayer's documentation 2020-01-18 21:51:17 +08:00
Hugo Locurcio
9914b6fc62
doc: Mention the limited comment support in ConfigFile 2020-01-18 13:58:36 +01:00
Rémi Verschelde
ea1da40d79
Merge pull request #35223 from Feniks-Gaming/MenueButtonDescription
Improved MenuButton Description
2020-01-18 09:25:49 +01:00
Feniks
156f5b7ce2 Improved MenuButton Description
I expanded description of MenueButton to explain how to create the items inside of the pop up as this is initially a mystery to many new people.
2020-01-18 07:22:19 +00:00
Haoyu Qiu
9882cbf8cd Improves LineEdit documentation
* Recently supported macOS shortcuts are added
* Makes it clear than `set_text` won't trigger `text_changed`
* `minimum_spaces` is the number of space characters that can be shown
  without scrolling
2020-01-17 11:02:43 +08:00
Rémi Verschelde
1de633205f Validate input in (CPU)Particles set_emission_shape()
Fixes #29777.

Co-authored-by: Cameron Reikes <cameronreikes@gmail.com>
2020-01-16 11:08:51 +01:00
Rémi Verschelde
7c624949b5
Merge pull request #35147 from madmiraal/fix-34992
Fixes get_floor_normal() returning the user defined floor_normal.
2020-01-15 14:17:15 +01:00
Marcel Admiraal
907adb37ce Fixes get_floor_normal() returning the user defined floor_normal.
When there is no collision with a floor the get_floor_normal() function
should return the zero vector to be consistent with get_floor_velocity().

Renames floor_normal to up_direction in all bindings.

Updates the documentation of get_floor_normal() and get_floor_velocity()
to make it clear when the values are valid. Updates the documentation for
move_and_slide() and move_and_slide_with_snap() to use the new up_direction
parameter name.
2020-01-15 10:13:35 +01:00
Rémi Verschelde
6e8eb0d98d
Merge pull request #35134 from clayjohn/DOCS-update-multiple
Completed documentation for many visual nodes
2020-01-15 08:10:15 +01:00
clayjohn
46b5742159 Completed documentation for many visual nodes 2020-01-14 18:28:36 -08:00
Rémi Verschelde
40f0649e5b Fix typos with codespell
Using codespell 1.16.0.

See ab3bccdb78 for procedure.
2020-01-15 00:49:52 +01:00
Rémi Verschelde
083f68ebf4
Merge pull request #35077 from Feniks-Gaming/master
Expanded bool class description with examples
2020-01-14 23:11:20 +01:00
Feniks
636f003f8c Expanded class_bool Description with examples
I expanded boolean long description with example of when booleans could be use practice because

Boolean

Description:

Boolean built-in type.

was pretty vague. As new to programming person it took me longer than it should have to understand what those are and why I would want to use them. Hopefully this will make it clearer to new users reading documentation
Update bool.xml
2020-01-14 21:45:47 +00:00
Andrii Doroshenko (Xrayez)
42567bffb9 Document Engine.get_idle/physics_frames methods 2020-01-14 22:32:32 +02:00
Rémi Verschelde
1bafd2d2c8
Merge pull request #35120 from Faless/docs/html5_restrictions
Update documentation to reflect HTML5 limitations.
2020-01-14 17:23:54 +01:00
Fabio Alessandrelli
aa744aee7d Update documentation to reflect HTML5 limitations. 2020-01-14 15:42:47 +01:00
Tomasz Chabora
c09b9c488f Complete documentation of some more classes 2020-01-14 13:19:39 +01:00
Rémi Verschelde
ab97f78fa5 Revert "Enable Vsync via Compositor by default"
This reverts commit 9600fd5dde.

Add comment warning about possible implications of using this option.

Fixes #35038.
2020-01-13 09:33:27 +01:00
Rémi Verschelde
7f9bf5472c doc: Sync classref with current source 2020-01-12 14:30:21 +01:00
Rémi Verschelde
478ab8b45b
Merge pull request #34960 from johannesgunnar/spin_box-apply-method
Spinbox apply input method
2020-01-12 14:16:14 +01:00
Jóhannes Gunnar Þorsteinsson
083637a901 Add apply method to SpinBox 2020-01-11 10:47:51 +00:00
Rémi Verschelde
d842557afe
Merge pull request #35001 from KoBeWi/nope
Add signal for LineEdit overflow event
2020-01-10 23:46:02 +01:00
Rémi Verschelde
f39f62954e
Merge pull request #34999 from cajallen/master
Updated Array's sort_custom method documentation
2020-01-10 21:57:28 +01:00
Tomasz Chabora
60cd3df337 Add signal for LineEdit overflow event 2020-01-10 21:07:00 +01:00
Chris Bradfield
378c4895ae [DOCS] Corrections and clarifications to classref 2020-01-10 10:46:41 -08:00
cajallen
05bbbb1225 sort_custom description and example updated 2020-01-10 12:24:49 -06:00
Rémi Verschelde
a24aa591af
Merge pull request #34991 from Calinou/doc-os-is-debug-build
Improve the `OS.is_debug_build()` documentation
2020-01-10 15:51:16 +01:00
Hugo Locurcio
74ae1ca616
Improve the OS.is_debug_build() documentation 2020-01-10 15:26:47 +01:00
Rémi Verschelde
673f4fabd8
Merge pull request #34962 from KoBeWi/randocs
Complete documentation of various classes
2020-01-10 14:41:30 +01:00
Tomasz Chabora
508e624b87 Complete documentation of various classes 2020-01-10 14:14:07 +01:00