Expose an ImportOrder enum in ResourceImporter

This avoids using magic numbers in code.
This commit is contained in:
Hugo Locurcio
2021-07-23 12:10:32 +02:00
parent 515670351a
commit 7f83977f37
5 changed files with 28 additions and 3 deletions

View File

@ -1,13 +1,22 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporter" inherits="RefCounted" version="4.0">
<brief_description>
Base class for the implementation of core resource importers.
</brief_description>
<description>
This is the base class for the resource importers implemented in core. To implement your own resource importers using editor plugins, see [EditorImportPlugin].
</description>
<tutorials>
<link title="Import plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/import_plugins.html</link>
</tutorials>
<methods>
</methods>
<constants>
<constant name="IMPORT_ORDER_DEFAULT" value="0" enum="ImportOrder">
The default import order.
</constant>
<constant name="IMPORT_ORDER_SCENE" value="100" enum="ImportOrder">
The import order for scenes, which ensures scenes are imported [i]after[/i] all other core resources such as textures. Custom importers should generally have an import order lower than [code]100[/code] to avoid issues when importing scenes that rely on custom resources.
</constant>
</constants>
</class>