:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PackedScene.xml. .. _class_PackedScene: PackedScene =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Inherited By:** :ref:`PackedSceneGLTF` An abstraction of a serialized scene. .. rst-class:: classref-introduction-group Description ----------- A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself. 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 ``owner`` property on :ref:`Node`). \ **Note:** The node doesn't need to own itself. \ **Example of loading a saved scene:**\ :: # 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) \ **Example of saving a node with different owners:** The following example creates 3 objects: ``Node2D`` (``node``), ``RigidBody2D`` (``rigid``) and ``CollisionObject2D`` (``collision``). ``collision`` is a child of ``rigid`` which is a child of ``node``. Only ``rigid`` is owned by ``node`` and ``pack`` will therefore only save those two nodes, but not ``collision``. :: # Create the objects. var node = Node2D.new() var rigid = RigidBody2D.new() var collision = CollisionShape2D.new() # Create the object hierarchy. rigid.add_child(collision) node.add_child(rigid) # Change owner of `rigid`, but not of `collision`. rigid.owner = node var scene = PackedScene.new() # Only `node` and `rigid` are now packed. var result = scene.pack(node) if result == OK: 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.") .. rst-class:: classref-introduction-group Tutorials --------- - `2D Role Playing Game Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`_bundled` | ``{"conn_count": 0,"conns": PoolIntArray( ),"editable_instances": [ ],"names": PoolStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PoolIntArray( ),"variants": [ ],"version": 2}`` | +-------------------------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_instance` **(** **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SceneState` | :ref:`get_state` **(** **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`instance` **(** :ref:`GenEditState` edit_state=0 **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`pack` **(** :ref:`Node` path **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_PackedScene_GenEditState: .. rst-class:: classref-enumeration enum **GenEditState**: .. _class_PackedScene_constant_GEN_EDIT_STATE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`GenEditState` **GEN_EDIT_STATE_DISABLED** = ``0`` If passed to :ref:`instance`, blocks edits to the scene state. .. _class_PackedScene_constant_GEN_EDIT_STATE_INSTANCE: .. rst-class:: classref-enumeration-constant :ref:`GenEditState` **GEN_EDIT_STATE_INSTANCE** = ``1`` If passed to :ref:`instance`, provides local scene resources to the local scene. \ **Note:** Only available in editor builds. .. _class_PackedScene_constant_GEN_EDIT_STATE_MAIN: .. rst-class:: classref-enumeration-constant :ref:`GenEditState` **GEN_EDIT_STATE_MAIN** = ``2`` If passed to :ref:`instance`, provides local scene resources to the local scene. Only the main scene should receive the main edit state. \ **Note:** Only available in editor builds. .. _class_PackedScene_constant_GEN_EDIT_STATE_MAIN_INHERITED: .. rst-class:: classref-enumeration-constant :ref:`GenEditState` **GEN_EDIT_STATE_MAIN_INHERITED** = ``3`` It's similar to :ref:`GEN_EDIT_STATE_MAIN`, but for the case where the scene is being instantiated to be the base of another one. \ **Note:** Only available in editor builds. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_PackedScene_property__bundled: .. rst-class:: classref-property :ref:`Dictionary` **_bundled** = ``{"conn_count": 0,"conns": PoolIntArray( ),"editable_instances": [ ],"names": PoolStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PoolIntArray( ),"variants": [ ],"version": 2}`` 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. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_PackedScene_method_can_instance: .. rst-class:: classref-method :ref:`bool` **can_instance** **(** **)** |const| Returns ``true`` if the scene file has nodes. .. rst-class:: classref-item-separator ---- .. _class_PackedScene_method_get_state: .. rst-class:: classref-method :ref:`SceneState` **get_state** **(** **)** Returns the ``SceneState`` representing the scene file contents. .. rst-class:: classref-item-separator ---- .. _class_PackedScene_method_instance: .. rst-class:: classref-method :ref:`Node` **instance** **(** :ref:`GenEditState` edit_state=0 **)** |const| Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a :ref:`Node.NOTIFICATION_INSTANCED` notification on the root node. .. rst-class:: classref-item-separator ---- .. _class_PackedScene_method_pack: .. rst-class:: classref-method :ref:`Error` **pack** **(** :ref:`Node` path **)** Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.owner`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`