summaryrefslogtreecommitdiffstats
path: root/doc/classes/EditorImportPlugin.xml
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #99020 from Mickeon/documentation-example-pruning-2Thaddeus Crews2024-11-121-1/+1
|\ | | | | | | Clean up more `[b]Example:[/b]` lines from the class reference
| * Clean up more `[b]Example:[/b]` lines from the class referenceMicky2024-11-111-1/+1
| |
* | Fix freeze on non-thread-safe custom importersHunter Loftis2024-10-151-1/+2
|/
* Merge pull request #95336 from esainane/typo-ehRémi Verschelde2024-08-121-1/+1
|\ | | | | | | Fix typo in EditorImportPlugin docs
| * Fix typo in EditorImportPlugin docsSai Nane2024-08-091-1/+1
| | | | | | | | "[param custom_importer] ca be" -> "[param custom_importer] can be"
* | Fix documentation of `EditorImportPlugin._Import`Sai Nane2024-08-091-3/+3
|/ | | | | | | | | | | | | | The following is the currently generated `EditorImportPlugin.cs`: ```csharp public virtual Error _Import(string sourceFile, string savePath, Dictionary options, Array<string> platformVariants, Array<string> genFiles) { return Error.Ok; } ``` This fixes the type signature in the documentation's example to match the actual type signature.
* Allow EditorImportPlugin to override can_import_threaded()Pedro J. Estébanez2024-01-091-0/+7
|
* Validate `code` tags for class and member referencesYuri Sizov2023-10-031-1/+1
| | | | | | | | This commit also adds means to manually disable warnings in `code` tags where it's a false positive with the new `skip-lint` attribute. Warnings are now enabled on CI to prevent future errors.
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-061-1/+1
| | | | | | 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).
* Bump version to 4.2-devRémi Verschelde2023-07-051-1/+1
| | | | Keep on waitin'
* Fix function signature in EditorImportPlugin exampleHaoyu Qiu2023-06-281-2/+2
|
* C#: Fix dictionary key lookup documentationRaul Santos2023-06-021-4/+4
| | | | The method to check if a key exists in the dictionary is called `ContainsKey`.
* Bump version to 4.1-devRémi Verschelde2023-03-011-1/+1
| | | | Can't stop, won't stop, they said, huh?
* Use reimport_append api for importing embedded gltf imagesLyuma2023-02-061-1/+2
| | | | Co-authored-by: K. S. Ernest (iFire) Lee <ernest.lee@chibifire.com>
* Merge pull request #72455 from reduz/allow-reimport-appendingRémi Verschelde2023-02-061-0/+9
|\ | | | | | | Support reimport appending
| * Support reimport appendingJuan Linietsky2023-02-011-0/+9
| | | | | | | | | | | | | | * Add API: `EditorFileSystem::reimport_append(path)`, thread safe, what can be used from importers when they generate new files within the import process. * Added a `remap.gen_param` custom value to .import files, which can be used by importers to store data needed to generate this file again or not. This API is added to allow the GLTF2 importer to properly extract png files as textures.
* | Merge pull request #71479 from raulsntos/virtual-return-typeRémi Verschelde2023-02-011-1/+1
|\ \ | | | | | | | | | Use enum instead of int in virtual methods return type
| * | Use enum instead of int in virtual methods return typeRaul Santos2023-01-311-1/+1
| |/
* / Fix C# examples in documentationRaul Santos2023-01-311-16/+22
|/ | | | | | | | | | - 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.
* docs: replace File with FileAccessJiri Suchan2023-01-301-2/+2
|
* Merge pull request #66232 from Evanaellio/fix-tool-annotationRémi Verschelde2022-09-221-1/+1
|\ | | | | Fix code examples for @tool annotation
| * Fix code examples for @tool annotationEvanaellio2022-09-211-1/+1
| |
* | Swap arguments of ResourceSaver.save()Evanaellio2022-09-211-2/+2
|/
* Change Array arguments to TypedArraykobewi2022-09-011-2/+2
|
* Replace Array return types with TypedArraykobewi2022-08-221-1/+1
|
* [doc] Use "param" instead of "code" to refer to parameters (6)Andy Maloney2022-08-121-1/+1
|
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-081-11/+11
|
* Add an XML schema for documentationHugo Locurcio2022-02-151-1/+1
| | | | | | | | 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.
* Fix usage of "Return" in the docskobewi2022-01-021-1/+1
|
* Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde2021-11-151-1/+1
|
* Add path to functions that return iporter optionsreduz2021-11-141-3/+5
| | | | | | | -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.
* Restrict the project data directory configurationne0fhyk2021-10-181-2/+2
|
* Improve docs about plugin registrationkobewi2021-10-171-1/+2
|
* Make the project data directory customizable.ne0fhyk2021-10-111-2/+2
|
* Don't generate empty doc sections and reduce code duplicationAaron Franke2021-09-201-2/+0
|
* Replace BIND_VMETHOD by new GDVIRTUAL syntaxreduz2021-08-221-16/+16
| | | | | | | | | | | * 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.
* doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-301-42/+21
| | | | | | | | 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.
* Expose an ImportOrder enum in ResourceImporterHugo Locurcio2021-07-231-1/+1
| | | | This avoids using magic numbers in code.
* Consistently prefix bound virtual methods with _kobewi2021-06-121-25/+25
|
* Style: Cleanup uses of double spaces between wordsRémi Verschelde2021-06-071-1/+1
| | | | | Or after punctuation. Tried to leave third-party stuff alone, unless it has been heavily modified for Godot.
* Clarify EditorImportPlugin.get_visible_name.Ryan Roden-Corrent2021-02-111-7/+5
| | | | | | | | | | | | | | | | | | 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.
* Port code examples to C# (D)HaSa10022020-11-011-8/+85
| | | | | | | | | | | | | | | | | | | | Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
* Rename the ".import" folder to ".godot/imported"Aaron Franke2020-09-281-2/+2
|
* Add link titles for all links in the class referenceHugo Locurcio2020-08-311-1/+1
| | | | | This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
* Document several editor-related classes to 100% completionHugo Locurcio2020-07-201-0/+12
|
* Update docs to version 4.0clayjohn2020-01-311-1/+1
|
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-261-1/+1
| | | | | | | | | | 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.
* doc: Remove hardcoded default values from descriptionsRémi Verschelde2019-06-301-1/+1
| | | | They are now generated automatically by doctool.
* Proofread and improve the whole class referenceHugo Locurcio2019-06-271-12/+12
| | | | | | | | | | | | | - 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
* doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde2019-06-271-1/+1
|