class_packedscene.rst 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the PackedScene.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_PackedScene:
  5. PackedScene
  6. ===========
  7. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +--------------------------------------+----------------------------------------------------------------------------------------------------+
  14. | :ref:`bool<class_bool>` | :ref:`can_instance<class_PackedScene_can_instance>` **(** **)** const |
  15. +--------------------------------------+----------------------------------------------------------------------------------------------------+
  16. | :ref:`SceneState<class_scenestate>` | :ref:`get_state<class_PackedScene_get_state>` **(** **)** |
  17. +--------------------------------------+----------------------------------------------------------------------------------------------------+
  18. | :ref:`Node<class_node>` | :ref:`instance<class_PackedScene_instance>` **(** :ref:`int<class_int>` edit_state=0 **)** const |
  19. +--------------------------------------+----------------------------------------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`pack<class_PackedScene_pack>` **(** :ref:`Node<class_node>` path **)** |
  21. +--------------------------------------+----------------------------------------------------------------------------------------------------+
  22. Member Variables
  23. ----------------
  24. - :ref:`Dictionary<class_dictionary>` **_bundled**
  25. Numeric Constants
  26. -----------------
  27. - **GEN_EDIT_STATE_DISABLED** = **0**
  28. - **GEN_EDIT_STATE_INSTANCE** = **1**
  29. - **GEN_EDIT_STATE_MAIN** = **2**
  30. Description
  31. -----------
  32. TODO: explain ownership, and that node does not need to own itself
  33. Member Function Description
  34. ---------------------------
  35. .. _class_PackedScene_can_instance:
  36. - :ref:`bool<class_bool>` **can_instance** **(** **)** const
  37. .. _class_PackedScene_get_state:
  38. - :ref:`SceneState<class_scenestate>` **get_state** **(** **)**
  39. .. _class_PackedScene_instance:
  40. - :ref:`Node<class_node>` **instance** **(** :ref:`int<class_int>` edit_state=0 **)** const
  41. .. _class_PackedScene_pack:
  42. - :ref:`int<class_int>` **pack** **(** :ref:`Node<class_node>` path **)**
  43. Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner<class_Node_set_owner>`.