2017-11-24 08:16:27 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 09:32:53 +00:00
<class name= "EditorScenePostImport" inherits= "Reference" category= "Core" version= "3.1.2" >
2017-11-24 08:16:27 +00:00
<brief_description >
2018-01-19 23:48:44 +00:00
Post process scenes after import
2017-11-24 08:16:27 +00:00
</brief_description>
<description >
2018-09-21 13:34:11 +00:00
Imported scenes can be automatically modified right after import by setting their [i]Custom Script[/i] Import property to a [code]tool[/code] script that inherits from this class.
The [method post_import] callback receives the imported scene's root node and returns the modified version of the scene. Usage example:
2018-01-19 23:48:44 +00:00
[codeblock]
2018-09-21 13:34:11 +00:00
tool # needed so it runs in editor
extends EditorScenePostImport
2018-01-19 23:48:44 +00:00
2018-09-21 13:34:11 +00:00
# This sample changes all node names
2018-01-19 23:48:44 +00:00
2018-09-21 13:34:11 +00:00
# Called right after the scene is imported and gets the root node
func post_import(scene):
# change all node names to "modified_[oldnodename]"
iterate(scene)
return scene # remember to return the imported scene
2018-01-19 23:48:44 +00:00
2018-09-21 13:34:11 +00:00
func iterate(node):
if node != null:
2018-12-14 08:37:19 +00:00
node.name = "modified_" + node.name
2018-09-21 13:34:11 +00:00
for child in node.get_children():
iterate(child)
[/codeblock]
</description>
<tutorials >
2019-06-01 09:39:12 +00:00
<link > https://docs.godotengine.org/en/3.1/getting_started/workflow/assets/importing_scenes.html#custom-script</link>
2018-09-21 13:34:11 +00:00
</tutorials>
2017-11-24 08:16:27 +00:00
<methods >
2018-01-19 23:48:44 +00:00
<method name= "get_source_file" qualifiers= "const" >
<return type= "String" >
</return>
<description >
2018-09-21 13:34:11 +00:00
Returns the source file path which got imported (e.g. [code]res://scene.dae[/code]).
2018-01-19 23:48:44 +00:00
</description>
</method>
<method name= "get_source_folder" qualifiers= "const" >
<return type= "String" >
</return>
<description >
2018-09-21 13:34:11 +00:00
Returns the resource folder the imported scene file is located in.
2018-01-19 23:48:44 +00:00
</description>
</method>
2017-11-24 08:16:27 +00:00
<method name= "post_import" qualifiers= "virtual" >
2018-01-19 23:48:44 +00:00
<return type= "Object" >
2017-11-24 08:16:27 +00:00
</return>
<argument index= "0" name= "scene" type= "Object" >
</argument>
<description >
2018-09-21 13:34:11 +00:00
Gets called after the scene got imported and has to return the modified version of the scene.
2017-11-24 08:16:27 +00:00
</description>
</method>
</methods>
<constants >
</constants>
</class>