godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/EditorSceneFormatImporter.xml

62 lines
2.1 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
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-14 13:18:53 +00:00
<class name="EditorSceneFormatImporter" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
<brief_description>
Add docs for EditorInterface, EditorPlugin and EditorSceneImporter
2019-07-20 13:41:42 +00:00
Imports scenes from third-parties' 3D files.
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</brief_description>
<description>
Improve docs about plugin registration
2021-10-15 12:30:58 +00:00
[EditorSceneFormatImporter] allows to define an importer script for a third-party 3D format.
To use [EditorSceneFormatImporter], register it using the [method EditorPlugin.add_scene_format_importer_plugin] method first.
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</description>
<tutorials>
</tutorials>
<methods>
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 01:52:44 +00:00
<method name="_get_extensions" qualifiers="virtual const">
<return type="PackedStringArray" />
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
<description>
</description>
</method>
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 01:52:44 +00:00
<method name="_get_import_flags" qualifiers="virtual const">
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 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
<description>
</description>
</method>
Add path to functions that return iporter options -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-11-14 17:02:38 +00:00
<method name="_get_import_options" qualifiers="virtual">
<return type="void" />
<argument index="0" name="path" type="String" />
<description>
</description>
</method>
<method name="_get_option_visibility" qualifiers="virtual const">
<return type="Variant" />
<argument index="0" name="path" type="String" />
Import scenes as AnimationLibrary Added the ability to import scenes as AnimationLibrary * Completes implementation of https://github.com/godotengine/godot-proposals/issues/4296 * Helps if you want to export animations to a separate file (say a GLTF) to avoid re-importing/exporting them every time the model changes. * Helps if you simply want to have animations using a dummy model, which can be shared across multiple models. Creates a secondary scene importer used only for animations. **NOTE**: A new flag for scene importer: EditorSceneFormatImporter.IMPORT_DISCARD_MESHES_AND_MATERIALS has been added, to hint importers that they should skip meshes and animations (and hence make importing faster). It is not implemented in any importer yet, this should be done in a separate PR.
2022-04-12 14:07:09 +00:00
<argument index="1" name="for_animation" type="bool" />
<argument index="2" name="option" type="String" />
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
<description>
</description>
</method>
<method name="_import_scene" qualifiers="virtual">
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 01:52:44 +00:00
<return type="Object" />
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 13:28:05 +00:00
<argument index="0" name="path" type="String" />
<argument index="1" name="flags" type="int" />
options dict is now passed to _import_scene.
2021-12-14 05:34:18 +00:00
<argument index="2" name="options" type="Dictionary" />
<argument index="3" name="bake_fps" type="int" />
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
<description>
</description>
</method>
</methods>
<constants>
<constant name="IMPORT_SCENE" value="1">
</constant>
<constant name="IMPORT_ANIMATION" value="2">
</constant>
doc: Sync classref with current source
2021-03-25 11:19:51 +00:00
<constant name="IMPORT_FAIL_ON_MISSING_DEPENDENCIES" value="4">
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</constant>
doc: Sync classref with current source
2021-03-25 11:19:51 +00:00
<constant name="IMPORT_GENERATE_TANGENT_ARRAYS" value="8">
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</constant>
doc: Sync classref with current source
2021-03-25 11:19:51 +00:00
<constant name="IMPORT_USE_NAMED_SKIN_BINDS" value="16">
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</constant>
Import scenes as AnimationLibrary Added the ability to import scenes as AnimationLibrary * Completes implementation of https://github.com/godotengine/godot-proposals/issues/4296 * Helps if you want to export animations to a separate file (say a GLTF) to avoid re-importing/exporting them every time the model changes. * Helps if you simply want to have animations using a dummy model, which can be shared across multiple models. Creates a secondary scene importer used only for animations. **NOTE**: A new flag for scene importer: EditorSceneFormatImporter.IMPORT_DISCARD_MESHES_AND_MATERIALS has been added, to hint importers that they should skip meshes and animations (and hence make importing faster). It is not implemented in any importer yet, this should be done in a separate PR.
2022-04-12 14:07:09 +00:00
<constant name="IMPORT_DISCARD_MESHES_AND_MATERIALS" value="32">
</constant>
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</constants>
</class>