summaryrefslogtreecommitdiff
path: root/doc/classes/EditorImportPlugin.xml
AgeCommit message (Collapse)Author
2022-08-12[doc] Use "param" instead of "code" to refer to parameters (6)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-02-15Add an XML schema for documentationHugo Locurcio
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-01-02Fix usage of "Return" in the docskobewi
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-11-14Add path to functions that return iporter optionsreduz
-Allows displaying custom options for specific file format variants -Added support for scene format import to retrieve custom options This PR is necessary for #54886 to be implemented properly.
2021-10-18Restrict the project data directory configurationne0fhyk
2021-10-17Improve docs about plugin registrationkobewi
2021-10-11Make the project data directory customizable.ne0fhyk
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-08-22Replace BIND_VMETHOD by new GDVIRTUAL syntaxreduz
* 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-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
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-23Expose an ImportOrder enum in ResourceImporterHugo Locurcio
This avoids using magic numbers in code.
2021-06-12Consistently prefix bound virtual methods with _kobewi
2021-06-07Style: Cleanup uses of double spaces between wordsRémi Verschelde
Or after punctuation. Tried to leave third-party stuff alone, unless it has been heavily modified for Godot.
2021-02-11Clarify EditorImportPlugin.get_visible_name.Ryan Roden-Corrent
According to the docs at https://docs.godotengine.org/en/stable/tutorials/plugins/editor/import_plugins.html#the-editorimportplugin-class > The get_visible_name() method is responsible for returning the name of > the type it imports and it will be shown to the user in the Import dock. > You should choose this name as a continuation to "Import as", e.g. > "Import as Silly Material" I've verified Godot's behavior reflects this, so the code examples should reflect this. Also document propagating save error in EditorImportPlugin. It seems that the suggested code ignores any error from `ResourceSaver.save`, but I think we should return it.
2020-11-01Port code examples to C# (D)HaSa1002
Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-09-28Rename the ".import" folder to ".godot/imported"Aaron Franke
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-07-20Document several editor-related classes to 100% completionHugo Locurcio
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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.
2019-06-30doc: Remove hardcoded default values from descriptionsRémi Verschelde
They are now generated automatically by doctool.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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-27doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2018-12-29doc: Fix references to setters and misc formattingRémi Verschelde
2018-12-27doc: Sync classref with current sourceRémi Verschelde
Fix various code formatting issues and argument names.
2018-12-14doc: Fix formatting in code blocksRémi Verschelde
2018-11-05doc: Use HTTPS for docs.godotengine.org and point to latest branchRémi Verschelde
Fixes #23509.
2018-09-23[Docs] Remove double-spaces from descriptions, as well a couple other small ↵LikeLakers2
fixes
2018-09-21doc: Misc formatting fixesRémi Verschelde
2018-07-24Fix example code for EditorImportPluginNoshyaar
2018-06-15doc: Remove extraneous empty lines in descriptionsRémi Verschelde
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Update version string in headerRémi Verschelde
2018-02-13Expose priority and order for custom import pluginsGeorge Marques
2018-01-25doc: Sync with current sourceRémi Verschelde
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-13doc: Update version string in XMLRémi Verschelde
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-15doc: Remove revision.module_config from version stringRémi Verschelde
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-10-25Fix example code for EditorImportPluginvolzhs
2017-10-14[DOCS] Fix a few typos.Andreas Haas
2017-09-16Added EditorImportPlugin class ref docsRalph Minderhoud
2017-09-12Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky
possible to save module files in module directories and the build system will recognize them.