mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-27 09:16:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
26,844 Commits 15 Branches 59 Tags 7.6 GiB
c1fe53a933
Commit Graph

2517 Commits

Author SHA1 Message Date
Rémi Verschelde
6b42d83ff1
Merge pull request #35950 from Chaosus/vs_scalar_uniform_range 
Implemented hint_range for VisualShaderNodeScalarUniform
 2020-02-07 20:45:40 +01:00
Rémi Verschelde
3fba20141b
Merge pull request #35925 from seenloitering/doc-Skeleton2D 
Add documentation for Skeleton2D
 2020-02-07 17:44:14 +01:00
Yuri Roubinsky
22ad83edae Implemented hint_range for VisualShaderNodeScalarUniform 2020-02-07 17:04:24 +03:00
Haoyu Qiu
7a41c44be2 Completes doc for ItemList and Tree 2020-02-07 12:52:53 +08:00
Yuri Roubinsky
d9b39abbeb Fixed Grammer 2020-02-06 22:00:48 +02:00
Rémi Verschelde
c358399f81
Merge pull request #35911 from clayjohn/DOCS-misc3 
Finish documenting BakedLightmap and TextureLayered
 2020-02-05 21:05:34 +01:00
clayjohn
5643bc71f7 Finish documenting BakedLightmap and TextureLayered 2020-02-05 08:13:34 -08:00
Rémi Verschelde
0317d49951
Merge pull request #35807 from Calinou/improve-doc-status-output 
Improve the `doc_status.py` console output
 2020-02-05 16:59:16 +01:00
seenloitering
9151992432 Add documentation for Skeleton2D 
Signal bone_setup_changed remains undocumented. I took a quick look at
the cpp code, but its purpose remained unclear to me. If anyone can
steer me in the right direction, I'm happy to flesh this out.
 2020-02-05 07:19:27 -05:00
Haoyu Qiu
db42d5ddff Completes doc for button classes 2020-02-05 08:44:16 +08:00
Rémi Verschelde
0edcb8ed58
Merge pull request #35809 from clayjohn/DOCS-update-version 
Update docs to version 4.0
 2020-02-01 19:42:31 +01:00
Haoyu Qiu
4774043f8e Adds CTRL-A CTRL-E support to LineEdit on macOS 2020-02-01 13:35:16 +08:00
clayjohn
57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08:00
clayjohn
be39808b00 Unexpose ARRAY_COMPRESS_BASE 2020-01-31 16:29:46 -08:00
Hugo Locurcio
7c3f6b2870
Improve the doc_status.py console output 
- Duplicate the header when the `-a` flag is enabled. Since lots of
  items are displayed in this case, this helps the user remember
  which column is which without having to scroll back to the top.
- Bolden the overall percentages for easier visual grepping.
 2020-02-01 00:24:39 +01:00
Hugo Locurcio
1de9118c5f
doc: Add an example for Array.sort() 
This may help people understand the difference between alphabetical
and natural order more quickly.
 2020-01-31 21:23:09 +01:00
Rémi Verschelde
dfcfa7d256
Merge pull request #35790 from Calinou/doc-animationplayer-vs-tween 
doc: Add a short AnimationPlayer versus Tween comparison
 2020-01-31 18:29:34 +01:00
Hugo Locurcio
810b1341ce
doc: Add a short AnimationPlayer versus Tween comparison 
Many newcomers are confused about which one to choose for animating
properties. This should help clarify the situation with regards
to AnimationPlayer versus Tween.
 2020-01-31 18:00:15 +01:00
Hugo Locurcio
c9946bc87e
Improve the CheckBox and CheckButton class documentations 
This makes the CheckBox and CheckButton classes 100% documented.
 2020-01-31 13:17:20 +01:00
Rémi Verschelde
68eae6b6e9 Fix some URLs to use HTTPS when available 2020-01-29 02:48:10 +01:00
Hugo Locurcio
8ea77b96b2
Mention 2D polygon limits and how to increase them in the documentation 
This closes #21793.
 2020-01-28 22:04:29 +01:00
Rémi Verschelde
658e44ee01 doc: Sync classref with current source 
Fix a few typos.
 2020-01-28 10:58:48 +01:00
Yuri Roubinsky
766d1ef276 Docs for some nodes in visual shader(part 2) 2020-01-28 12:16:09 +03:00
Yuri Roubinsky
9705d5587e Hide "control" methods from VisualShaderNodeGroupBase 2020-01-28 10:24:59 +03:00
Yuri Roubinsky
274f1d8610 Hide "editable" property from VisualShaderNodeGroupBase public interface 2020-01-28 09:43:07 +03:00
Yuri Roubinsky
796484d761 Added missing property "size" to VisualShaderNodeGroupBase 2020-01-27 19:18:48 +03:00
Yuri Roubinsky
3479cf4b42 Removed unused method "build" from VisualShaderNodeExpression 2020-01-27 18:24:39 +03:00
Tomasz Chabora
21dd35b611 Document theme_items of multiple classes 2020-01-27 02:15:37 +01:00
Hugo Locurcio
75185f87a3
doc: Remove mention of nonexistent StaticBody simulated motion mode 
The StaticBody2D documentation doesn't mention it, so it doesn't need
to be touched.

This closes #30560.
 2020-01-26 20:18:22 +01:00
Rémi Verschelde
4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property 
doc: Drop unused 'category' property from header
 2020-01-26 16:34:13 +01:00
Rémi Verschelde
09ced94dd4 doc: Do not expose Variant::NIL as a type in the class reference 
Fix signals Variant arguments incorrectly listed as Nil.

Fixes #12520.
 2020-01-26 16:08:11 +01:00
Rémi Verschelde
2d20fc39aa doc: Drop unused 'category' property from header 
We already removed it from the online docs with #35132.

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
 2020-01-26 16:02:39 +01:00
Rémi Verschelde
3697ea799c doc: Document all remaining ProjectSettings 2020-01-26 13:37:21 +01:00
Rémi Verschelde
fe26e53065
Merge pull request #35581 from akien-mga/doc-color-constants 
doc: Document named color constants
 2020-01-26 13:36:44 +01:00
Rémi Verschelde
cbdbfb00ca doc: Document named color constants 
Busywork but it's good for our completion rate :)
 2020-01-26 12:08:16 +01:00
Rémi Verschelde
bb6c0d3e8b doc: Complete documentation for VideoStreams 
Also quick clean up of the matching C++ files.
 2020-01-26 11:29:07 +01:00
Rémi Verschelde
bd605a5701
Merge pull request #35566 from Xrayez/doc-parse-property-return 
Document the return value of `EditorInspectorPlugin.parse_property`
 2020-01-26 10:17:57 +01:00
Rémi Verschelde
6a5c8c8672
Merge pull request #35574 from clayjohn/DOCS-odds-n-ends 
Complete various class references
 2020-01-26 10:08:55 +01:00
clayjohn
c5700f7464 Complete various class references 2020-01-26 00:27:51 -08:00
Rémi Verschelde
1b3eb41622
Merge pull request #35561 from clayjohn/GLES3-irradiance-max 
Add project setting for max irradiance size
 2020-01-26 09:16:21 +01:00
Andrii Doroshenko (Xrayez)
06933f5d80 Document the return value of EditorInspectorPlugin.parse_property 2020-01-26 02:04:33 +02:00
Rémi Verschelde
be1bc53d42
Merge pull request #35560 from clayjohn/DOCS-sky-radiance 
Add warning for radiance_size
 2020-01-25 23:01:58 +01:00
clayjohn
7215019020 Add warning for radiance_size 2020-01-25 13:28:32 -08:00
clayjohn
eb5cb5d016 Add project setting for max irradiance size 2020-01-25 13:27:13 -08:00
Rémi Verschelde
8896ce1c0a
Merge pull request #35559 from Calinou/doc-inputeventkey-string 
Document how to get a human-readable string from an InputEventKey
 2020-01-25 21:52:35 +01:00
Hugo Locurcio
7a0c37c3f5
Document how to get a human-readable string from an InputEventKey 2020-01-25 20:13:18 +01:00
Hugo Locurcio
33f37cfd19
Document how to get chamfered corners with StyleBoxFlat 2020-01-25 20:04:23 +01:00
Rémi Verschelde
a61f5a7520
Merge pull request #35535 from Calinou/doc-projectsettings-runtime-physics 
Document how to change the default gravity at runtime
 2020-01-25 18:16:34 +01:00
Hugo Locurcio
1b9b07e658
Document how to change the default gravity at runtime 
Changing the default gravity at runtime isn't exactly obvious,
so it makes sense to add a code sample.
 2020-01-25 16:28:28 +01:00
Rémi Verschelde
e61edd69ea
Merge pull request #35523 from searetseltev/master 
Update ScrollContainer.xml
 2020-01-24 21:53:57 +01:00
Roi Valcárcel
4f0401d05d Update ScrollContainer.xml 
Add missing descriptions to ScrollContainer documentation
 2020-01-24 17:21:53 +01:00
Tomasz Chabora
25ea912d96 Count theme items in doc_status.py 2020-01-24 14:23:58 +01:00
Rémi Verschelde
97cc2e53f6 makerst: Escape reST markup after enums 
Fixes #35501.
 2020-01-24 13:08:36 +01:00
Yuri Roubinsky
ce43c92208 Docs for some nodes in visual shader 
Fix typo in `VisualShaderNodeCompare.ComparisonType` name.
 2020-01-23 22:39:00 +01:00
Rémi Verschelde
c66144738b
Merge pull request #35483 from YeldhamDev/doc_comment_spaces_removal 
Remove unnecessary extra spaces before comments in code examples.
 2020-01-23 21:58:12 +01:00
Michael Alexsander
c4745c96d7 Remove unnecessary extra spaces before comments in code examples. 2020-01-23 14:41:49 -03:00
Michael Alexsander
e1a9a3328d Remove unnecessary parenthesis from code examples 2020-01-23 14:15:39 -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
c0595206dd makerst: Use code markup for default values/overrides 
Fixes godotengine/godot-docs#3071.
 2020-01-20 12:38:08 +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
8d60f5a349
Merge pull request #35132 from Calinou/doc-description-below-brief 
doc: Move the class description to be just below the brief description
 2020-01-15 00:49:31 +01:00
Hugo Locurcio
3c8abbc4bf
doc: Move the class description to be just below the brief description 
- Drop the "Brief description" header as it became redundant
  with this change.
- Fix a bug in the editor help where an extraneous newline was added
  after the header if the class isn't inherited by any others.
- Remove the Category line in the rST markup as it's not useful
  for API users.
 2020-01-15 00:05:34 +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