mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
6e73aa0497
godot/doc/classes/EditorSceneFormatImporter.xml

68 lines
2.2 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2017-12-10 07:43:30 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Add scene Post-Import Plugin support. * New plugin system to control the whole import workflow * Can add options and run code at every import step (general, per node, mesh, animation, material etc.) This constitutes a first version of these plugins. The ability to interact with the import preview dialog will likely be added later on.
2021-10-15 01:34:27 +08:00
<class name="EditorSceneFormatImporter" inherits="RefCounted" version="4.0">
doc: Sync classref with current source
2017-12-10 07:43:30 +08:00
<brief_description>
Add docs for EditorInterface, EditorPlugin and EditorSceneImporter
2019-07-20 21:41:42 +08:00
Imports scenes from third-parties' 3D files.
doc: Sync classref with current source
2017-12-10 07:43:30 +08:00
</brief_description>
<description>
Improve docs about plugin registration
2021-10-15 20:30:58 +08: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-10 07:43:30 +08: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 09:52:44 +08:00
<method name="_get_extensions" qualifiers="virtual const">
<return type="PackedStringArray" />
doc: Sync classref with current source
2017-12-10 07:43:30 +08: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 09:52:44 +08: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 21:28:05 +08:00
<return type="int" />
doc: Sync classref with current source
2017-12-10 07:43:30 +08: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-15 01:02:38 +08: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" />
<argument index="1" name="option" type="String" />
<description>
</description>
</method>
doc: Sync classref with current source
2017-12-10 07:43:30 +08:00
<method name="_import_animation" qualifiers="virtual">
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 21:28:05 +08:00
<return type="Animation" />
<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 13:34:18 +08:00
<argument index="2" name="options" type="Dictionary" />
<argument index="3" name="bake_fps" type="int" />
doc: Sync classref with current source
2017-12-10 07:43:30 +08: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 09:52:44 +08: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 21:28:05 +08: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 13:34:18 +08:00
<argument index="2" name="options" type="Dictionary" />
<argument index="3" name="bake_fps" type="int" />
doc: Sync classref with current source
2017-12-10 07:43:30 +08: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 19:19:51 +08:00
<constant name="IMPORT_FAIL_ON_MISSING_DEPENDENCIES" value="4">
doc: Sync classref with current source
2017-12-10 07:43:30 +08:00
</constant>
doc: Sync classref with current source
2021-03-25 19:19:51 +08:00
<constant name="IMPORT_GENERATE_TANGENT_ARRAYS" value="8">
doc: Sync classref with current source
2017-12-10 07:43:30 +08:00
</constant>
doc: Sync classref with current source
2021-03-25 19:19:51 +08:00
<constant name="IMPORT_USE_NAMED_SKIN_BINDS" value="16">
doc: Sync classref with current source
2017-12-10 07:43:30 +08:00
</constant>
</constants>
</class>
Reference in New Issue Copy Permalink