b68dd2e189
Add an XML schema for documentation
...
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.
Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-15 00:03:31 +01:00
ec00283f91
ResourceImporter: Restore default append logic for new importers
...
This was changed in #56943 to allow adding new importers from plugins that
take precedence over built-in ones, but this should be opt-in, not the default
behavior.
Fixes #57730 .
2022-02-07 09:47:16 +01:00
7072b359b4
Improve some method bindings to use specific `Object` subtypes
...
This was made possible by changes to `VariantCaster` which now make
it possible to pass any `Object`-derived type as pointer.
2022-01-28 15:07:22 +01:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
a82347c12a
Merge pull request #53648 from pycbouh/docs-warn-about-internal-nodes
2021-10-18 11:22:58 +02:00
b3bf90b3ce
Add scene Post-Import Plugin support.
...
* New plugin system to control the whole import workflow
* Can add options and run code at every import step (general, per node, mesh, animation, material etc.)
This constitutes a first version of these plugins. The ability to interact with the import preview dialog will likely be added later on.
2021-10-15 09:12:04 -03:00
07725b611b
Add warnings to methods that give access to internal nodes
2021-10-10 22:57:58 +03:00
164dc11e04
Merge pull request #45699 from TokageItLab/implement-skeleton-editor-gizmo
...
Implement Skeleton Editor Gizmo
2021-10-06 21:11:20 +02:00
f2e9867e9f
Implemented SkeletonEditorGizmo
...
Co-authored-by: Lyuma <xn.lyuma@gmail.com>
2021-10-07 01:07:46 +09:00
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
02fa885402
Fix docs after GDVIRTUAL pull request
2021-08-25 19:45:27 -05:00
3682978aee
Replace BIND_VMETHOD by new GDVIRTUAL syntax
...
* New syntax is type safe.
* New syntax allows for type safe virtuals in native extensions.
* New syntax permits extremely fast calling.
Note: Everything was replaced where possible except for `_gui_input` `_input` and `_unhandled_input`.
These will require API rework on a separate PR as they work different than the rest of the functions.
Added a new method flag METHOD_FLAG_OBJECT_CORE, used internally. Allows to not dump the core virtuals like `_notification` to the json API, since each language will implement those as it is best fits.
2021-08-22 08:23:58 -03:00
7adf4cc9b5
doc: Use self-closing tags for `return` and `argument`
...
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
9a72b0d3d0
Fix doc typos
...
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`, `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.
2021-07-23 12:15:15 -04:00
27e9df7778
Add multiple descriptions to several classes
...
This pull request adds several descriptions to multiple different classes.
This improves the completeness of the documentation and enhances usability by doing so.
2021-07-06 07:40:27 -04:00
e28fd07b2b
Rename `instance()`->`instantiate()` when it's a verb
2021-06-19 20:49:18 -06:00
3911e71a52
Fix some virtual methods
2021-06-13 02:02:39 +02:00
7ff135b015
Consistently prefix bound virtual methods with _
2021-06-12 00:55:52 +02:00
21f0961610
Proofread add_*_plugin/remove_*_plugin descriptions in EditorPlugin
2021-06-03 15:00:19 +03:00
b80494e633
Merge pull request #47922 from RoniPerson/patch-3
...
Added documentation to some `add_*_plugin` methods
2021-06-03 13:26:33 +02:00
b46672db72
Provide a way to hook into Inspectors UndoRedo.
2021-05-04 09:55:22 +02:00
e849157e07
Added documentation to some `add_*_plugin` methods
...
Added documentation to some `add_*_plugin` methods and the corresponding `remove_*_plugin` methods.
Added an example of how to register a plugin to `add_inspector_plugin` and linked to it in the other methods.
2021-04-15 19:23:27 +02:00
034c48dbed
Add missing color argument in forward_canvas_draw_over_viewport example.
2021-04-09 16:49:04 +02:00
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
bc395c2549
Merge pull request #46221 from akien-mga/doc-sync-classref
...
doc: Sync classref with current source
2021-02-19 15:06:50 +01:00
0d1d719178
doc: Sync classref with current source
...
And fix various bogus bindings following previous PRs.
2021-02-19 14:39:14 +01:00
724ed88215
Add documentation for EditorPlugin's build method
2021-02-19 15:42:41 +03:00
8b231aff28
Complete documentation of EditorExportPlugin
2020-12-29 13:46:14 +01:00
889f5e44ef
Make tool menu plugins use Callables for callback
2020-12-16 20:23:51 +01:00
cbfbb4538b
Register methods for drawing 3D editor overlays
2020-11-10 11:35:34 +01:00
9dad1c4943
[Docs] Add C# example for EditorPlugin::forward_canvas_draw_over_viewport
...
Follow up to #43356
2020-11-10 10:24:17 +01:00
e0285dcc00
Merge pull request #43356 from KoBeWi/editor_art
...
Add docs for editor viewport drawing methods
2020-11-10 09:34:32 +01:00
593e35346a
Merge pull request #42841 from HaSa1002/docs-lang-3
...
Port code examples to C# (D and E)
2020-11-09 08:29:44 +01:00
5d8b60ac3d
Add docs for editor viewport drawing methods
2020-11-06 16:42:40 +01:00
424cd00f8b
doc: Sync classref with current source + fixup some bindings
...
Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
8fb113bb4c
Port code examples to C# (D)
...
Includes:
* Decal
* Dictionary
* Directory
* DisplayServer
* DTLSServer
* DynamicFont
* EditorImportPlugin
* EditorPlugin
* EditorScenePostImport
* EditorScript
* EditorSettings
* EditorTranslationParserPlugin
* Engine
* Expression
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-01 09:05:17 +01:00
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
ea2eaf8c27
Added debugger plugin support
...
Changes:
* EngineDebugger is exposed to gdscript. Game side of communication can be implemented through it.
* EditorDebuggerPlugin is added which handles the editor side of communication.
2020-08-26 11:24:51 +05:30
efb4609425
Add translation parser plugin support
2020-07-02 14:47:35 +02:00
31b7f02a29
Remove ToolButton in favor of Button
...
ToolButton has no redeeming differences with Button;
it's just a Button with the Flat property enabled by default.
Removing it avoids some confusion when creating GUIs.
Existing ToolButtons will be converted to Buttons, but the Flat
property won't be enabled automatically.
This closes https://github.com/godotengine/godot-proposals/issues/1081 .
2020-06-19 20:49:49 +02:00
eaaee63b62
doc: Update classref with node renames
...
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
68d73ecf60
Document EditorPlugin get_plugin_icon and get_plugin_name
...
The return value's type hint is now accurate.
2020-03-04 15:49:20 -05:00
213a85521d
doc: Sync classref with current source
...
Handle removal of Pool*Array types and other recent changes.
2020-02-18 14:02:02 +01:00
0e3d625737
doc: Sync classref with current source
...
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.
Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 12:37:13 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
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
45767fe5f6
Improve documentation of EditorPlugin.add_tool_submenu_item method
2019-08-12 20:58:21 +01:00
16288cabc0
doc: More formatting fixes
2019-07-22 12:41:41 +02:00
5b20b49bf7
doc: Formatting fixes in EditorPlugin docs
2019-07-22 12:37:33 +02:00
07e289963c
doc: Sync classref with current source
2019-07-22 12:27:52 +02:00
2acc1e3079
Add description for EditorPlugin.enable/disable methods
2019-07-20 10:53:56 -03:00
c7b0eed757
Add docs for EditorInterface, EditorPlugin and EditorSceneImporter
2019-07-20 10:41:42 -03:00
f7f6115f76
Proofread and improve the whole class reference
...
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
71d53637b5
doc: Fix scoped hyperlinks to same-class enums/methods
...
The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
86ed7a9884
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
cfb9709c10
doc: Sync classref with current source
2019-06-01 12:34:29 +02:00
426bcc9941
Change "Return" to "Returns" where necessary in XML documentation
...
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".
Fixes #28867
2019-05-23 21:11:24 -07:00
5fe2bf125a
Add description for EditorPlugin.update_overlays
2019-05-17 22:36:40 +09:00
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
ac46862097
Merge pull request #24506 from JFonS/expose_gizmos
...
Expose the new gizmo plugin system to scripting
2018-12-30 15:42:30 +01:00
2e39e38c10
doc: Sync classref with current source
...
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
6b15b4f904
Expose the new gizmo plugin system to scripting
2018-12-21 23:56:39 +01:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
f115f00ec6
Allow plugin scene change signal to report null for empty scenes.
2018-11-03 00:11:02 +02:00
0279985a70
Merge pull request #22218 from char0xff/doc_editorpluginsinterface
...
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-21 14:58:27 +02:00
83758a9004
doc: Sync classref with current source
2018-09-21 09:33:05 +02:00
a0efe25c9e
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 16:38:19 +02:00
29f2571662
update class docs
2018-08-31 22:35:15 +02:00
5267099a87
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
2a6c591957
Expose ScriptCreateDialog to EditorPlugin
2018-07-04 09:41:12 -05:00
98b59cf2a3
Add support for tutorial links to makerst.py
...
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
4c5dd51eb9
Sync classref with current source
...
Also fix binding of Basis.slerp
2018-05-28 14:53:15 +02:00
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
72aa87758a
Update classref and docs, fix missing parameters' name
2018-04-11 10:20:22 +07:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
3fa77b3172
doc: Remove status from hardcoded version string
...
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
eb63f7b071
[DOCS] Sync classref with current source
2018-02-25 15:14:25 +07:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
da69a06253
Add a function to remove controls from containers
...
Closes #5968
2018-02-13 19:35:10 -02:00
d516aab8fa
doc: Sync with current source
...
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
29e68aa40e
doc: Sync classref with current source
2018-01-07 01:37:45 +01:00
ce0f894b48
doc: Sync classref with current source
2017-12-10 00:43:49 +01:00
cb4c0c630f
doc: Sync classref with current source
2017-11-27 23:37:47 +01:00
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
62cb43bb8d
doc: Sync classref with current source
...
[ci skip]
2017-09-16 01:46:29 +02:00
4f929a0fdf
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
...
recognize them.
2017-09-12 17:45:41 -03:00
Hugo Locurcio
Rémi Verschelde
Rémi Verschelde
reduz
Yuri Sizov
Silc Renew
Aaron Franke
Nicholas Huelin
Lightning_A
kobewi
Gilles Roudière
RoniPerson
Anders Stenberg
Paul Joannon
HaSa1002
simpu
SkyJJ
clayjohn
Max Hunt
Henrique Campos
Sean Heffernan
volzhs
JFonS
Jared
Max Hilbrunner
char0xff
Kelly Thomas
willnationsdev
robojumper
Poommetee Ketson
George Marques