class_packedscene.rst 2.4 KB

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