Files
godot-docs/classes/class_packedscene.rst
2017-09-23 11:01:36 +02:00

71 lines
2.6 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PackedScene.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_PackedScene:
PackedScene
===========
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_instance<class_PackedScene_can_instance>` **(** **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`SceneState<class_scenestate>` | :ref:`get_state<class_PackedScene_get_state>` **(** **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`instance<class_PackedScene_instance>` **(** :ref:`int<class_int>` edit_state=0 **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`pack<class_PackedScene_pack>` **(** :ref:`Node<class_node>` path **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Dictionary<class_dictionary>` **_bundled**
Numeric Constants
-----------------
- **GEN_EDIT_STATE_DISABLED** = **0**
- **GEN_EDIT_STATE_INSTANCE** = **1**
- **GEN_EDIT_STATE_MAIN** = **2**
Description
-----------
TODO: explain ownership, and that node does not need to own itself
Member Function Description
---------------------------
.. _class_PackedScene_can_instance:
- :ref:`bool<class_bool>` **can_instance** **(** **)** const
.. _class_PackedScene_get_state:
- :ref:`SceneState<class_scenestate>` **get_state** **(** **)**
.. _class_PackedScene_instance:
- :ref:`Node<class_node>` **instance** **(** :ref:`int<class_int>` edit_state=0 **)** const
.. _class_PackedScene_pack:
- :ref:`int<class_int>` **pack** **(** :ref:`Node<class_node>` path **)**
Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner<class_Node_set_owner>`.