2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 13:40:34 +01:00
<class name= "PackedScene" inherits= "Resource" version= "3.3" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-12-04 05:34:28 +01:00
An abstraction of a serialized scene.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-12-04 05:34:28 +01:00
A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself.
2021-02-11 22:22:44 +01:00
Can be used to save a node to a file. When saving, the node as well as all the nodes it owns get saved (see [code]owner[/code] property on [Node]).
2019-06-22 01:04:47 +02:00
[b]Note:[/b] The node doesn't need to own itself.
2020-07-09 20:05:33 +02:00
[b]Example of loading a saved scene:[/b]
[codeblock]
# Use `load()` instead of `preload()` if the path isn't known at compile-time.
var scene = preload("res://scene.tscn").instance()
# Add the node as a child of the node the script is attached to.
add_child(scene)
[/codeblock]
2019-06-22 01:04:47 +02:00
[b]Example of saving a node with different owners:[/b] The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidBody2D[/code] ([code]rigid[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]rigid[/code] which is a child of [code]node[/code]. Only [code]rigid[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code].
2018-03-28 23:07:03 +02:00
[codeblock]
2020-04-17 22:27:01 +02:00
# Create the objects.
2018-10-21 19:34:30 +02:00
var node = Node2D.new()
var rigid = RigidBody2D.new()
var collision = CollisionShape2D.new()
2020-04-17 22:27:01 +02:00
# Create the object hierarchy.
2018-10-21 19:34:30 +02:00
rigid.add_child(collision)
node.add_child(rigid)
2020-04-17 22:27:01 +02:00
# Change owner of `rigid`, but not of `collision`.
2019-01-07 11:46:26 +01:00
rigid.owner = node
2018-10-21 19:34:30 +02:00
2018-03-28 23:07:03 +02:00
var scene = PackedScene.new()
2020-04-17 22:27:01 +02:00
# Only `node` and `rigid` are now packed.
2018-10-21 19:34:30 +02:00
var result = scene.pack(node)
2018-03-28 23:07:03 +02:00
if result == OK:
2020-04-17 22:27:01 +02:00
var error = ResourceSaver.save("res://path/name.scn", scene) # Or "user://..."
if error != OK:
push_error("An error occurred while saving the scene to disk.")
2018-03-28 23:07:03 +02:00
[/codeblock]
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2020-10-01 10:34:47 +02:00
<link title= "2D Role Playing Game Demo" > https://godotengine.org/asset-library/asset/520</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "can_instance" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2017-12-04 05:34:28 +01:00
Returns [code]true[/code] if the scene file has nodes.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_state" >
<return type= "SceneState" >
</return>
<description >
2017-12-04 05:34:28 +01:00
Returns the [code]SceneState[/code] representing the scene file contents.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "instance" qualifiers= "const" >
<return type= "Node" >
</return>
<argument index= "0" name= "edit_state" type= "int" enum= "PackedScene.GenEditState" default= "0" >
</argument>
<description >
2019-06-27 12:34:26 +02:00
Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a [constant Node.NOTIFICATION_INSTANCED] notification on the root node.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "pack" >
<return type= "int" enum= "Error" >
</return>
<argument index= "0" name= "path" type= "Node" >
</argument>
<description >
2019-01-07 11:46:26 +01:00
Pack will ignore any sub-nodes not owned by given node. See [member Node.owner].
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2019-07-15 20:42:47 +02:00
<member name= "_bundled" type= "Dictionary" setter= "_set_bundled_scene" getter= "_get_bundled_scene" default= "{"conn_count": 0,"conns": PoolIntArray( ),"editable_instances": [ ],"names": PoolStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PoolIntArray( ),"variants": [ ],"version": 2}" >
2017-12-04 05:34:28 +01:00
A dictionary representation of the scene contents.
Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "GEN_EDIT_STATE_DISABLED" value= "0" enum= "GenEditState" >
2017-12-04 05:34:28 +01:00
If passed to [method instance], blocks edits to the scene state.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "GEN_EDIT_STATE_INSTANCE" value= "1" enum= "GenEditState" >
2019-06-22 01:04:47 +02:00
If passed to [method instance], provides local scene resources to the local scene.
[b]Note:[/b] Only available in editor builds.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "GEN_EDIT_STATE_MAIN" value= "2" enum= "GenEditState" >
2019-06-22 01:04:47 +02:00
If passed to [method instance], provides local scene resources to the local scene. Only the main scene should receive the main edit state.
[b]Note:[/b] Only available in editor builds.
2017-09-12 22:42:36 +02:00
</constant>
</constants>
</class>