Commit Graph

45 Commits

Author SHA1 Message Date
292772a143 Deprecate get_scene() in EditorScript class 2025-10-22 17:03:41 -05:00
d9078d887f Merge pull request #109049 from ryevdokimov/deprecate-script-add-root-node
Relocate `add_root_node` method to `EditorInterface` from `EditorScript` and deprecate old method
2025-10-01 13:12:45 -05:00
11a4961081 Relocate add_root_node method to EditorInterface from EditorScript and deprecate old method 2025-08-05 17:23:57 +04:00
501675de85 Remove outdated note from EditorScript description 2025-07-29 13:43:22 +02:00
13f642d959 Replace XML codeblock spaces with tabs 2025-06-06 14:35:38 +02:00
1ca5bc2d04 Doc: Add "required" qualifier to methods 2025-06-05 21:41:07 +08:00
c2f33dbbe4 Editor: Add named EditorScripts to the command palette 2025-04-10 19:00:08 +02:00
932b1c434c Clean up more [b]Example:[/b] lines from the class reference 2024-11-11 12:05:34 +01:00
98871c3057 Fix add_root_node() being no-op 2024-04-03 20:07:56 +02:00
af28f87791 Documentation: Add support for deprecated/experimental messages 2024-02-15 15:59:50 +03:00
951ea2415b Make EditorInterface accessible as a singleton
- EditorPlugin.get_editor_interface() is removed as redundant.
2023-08-09 16:01:31 +02:00
81064cc239 Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
346f1ab86b Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
8a74d8438f Extract editor run toolbar into its own component
- Simplify and update its logic.
- Simplify EditorScript.
- Improve EditorNode and other relevant includes.
- Fix scene-based path in the movie writer when
reloading a scene.
2023-04-19 17:12:28 +02:00
1c1524a651 Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
7eb8325180 Fix C# examples in documentation
- Fix documentation after C# renames.
- Add missing `partial` in C# class declarations.
- Change `delta` parameter type to `double` in C#.
- Ensure parameters match base declaration.
- Use `$` string interpolation in C#.
- Fix invalid or outdated C# code.
- Changed some examples to follow our style guide more closely.
2023-01-31 19:04:07 +01:00
ee772f109f Merge pull request #66326 from zak-grumbles/editor_script_reference_docs
Add note regarding RefCounted to EditorScript docs
2022-10-19 22:02:46 +02:00
e5dc2ed982 Add note regarding RefCounted to EditorScript docs 2022-09-23 16:55:19 -05:00
6eac901ecb Fix code examples for @tool annotation 2022-09-21 22:52:55 +02:00
ea2192b99e [doc] Use "param" instead of "code" to refer to parameters (6) 2022-08-12 12:07:53 -04:00
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
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
d54f2ad7ca Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05: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
04688b92ff Rename Reference to RefCounted 2021-06-11 18:48:42 +02: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
1ea7295bd2 Improve shortcut formatting in docs 2020-04-10 18:42:11 +03: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
2bde99f790 Fix some small text mistakes 2019-11-08 23:31:29 +01: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
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +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
3c7a39b40c doc: Update version string in header 2018-02-19 10:46:33 +01: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
e28cdc4654 doc: Update version string in XML 2018-01-13 11:43:42 +01:00
2b59d30bdc [DOCS] EditorScript methods 2017-12-06 17:29:23 -06: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
649b25e037 [DOCS] EditorScript: Small formatting fixes 2017-10-23 00:35:10 +02:00
b302084395 makerst: Fix rst-ization of members and escaping of [Class]s
Fixes #11517.
2017-10-21 12:33:52 +02:00
8652c1d5b1 classref: Sync with current source 2017-10-21 12:04:36 +02:00
800904a374 [DOCS] EditorScript 2017-10-18 20:20:27 +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