Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 3.1
Branches Tags
godot-docs
/
classes
/
class_instanceplaceholder.rst

class_instanceplaceholder.rst 4.4 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the InstancePlaceholder.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_InstancePlaceholder:
    8. 

  8. 

  9. InstancePlaceholder
    10. 

  10. ===================
    11. 

  11. 

  12. **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

  17. -----------------
    18. 

  18. 

  19. Placeholder for the root :ref:`Node<class_Node>` of a :ref:`PackedScene<class_PackedScene>`.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`Node<class_Node>`             | :ref:`create_instance<class_InstancePlaceholder_method_create_instance>` **(** :ref:`bool<class_bool>` replace=false, :ref:`PackedScene<class_PackedScene>` custom_scene=null **)** |
    26. 

  26. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`String<class_String>`         | :ref:`get_instance_path<class_InstancePlaceholder_method_get_instance_path>` **(** **)** const                                                                                      |
    28. 

  28. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_stored_values<class_InstancePlaceholder_method_get_stored_values>` **(** :ref:`bool<class_bool>` with_order=false **)**                                                   |
    30. 

  30. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | void                                | :ref:`replace_by_instance<class_InstancePlaceholder_method_replace_by_instance>` **(** :ref:`PackedScene<class_PackedScene>` custom_scene=null **)**                                |
    32. 

  32. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. 

  34. Description
    35. 

  35. -----------
    36. 

  36. 

  37. Turning on the option **Load As Placeholder** for an instanced scene in the editor causes it to be replaced by an InstancePlaceholder when running the game. This makes it possible to delay actually loading the scene until calling :ref:`replace_by_instance<class_InstancePlaceholder_method_replace_by_instance>`. This is useful to avoid loading large scenes all at once by loading parts of it selectively.
    38. 

  38. 

  39. The InstancePlaceholder does not have a transform. This causes any child nodes to be positioned relatively to the Viewport from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again.
    40. 

  40. 

  41. Method Descriptions
    42. 

  42. -------------------
    43. 

  43. 

  44. .. _class_InstancePlaceholder_method_create_instance:
    45. 

  45. 

  46. - :ref:`Node<class_Node>` **create_instance** **(** :ref:`bool<class_bool>` replace=false, :ref:`PackedScene<class_PackedScene>` custom_scene=null **)**
    47. 

  47. 

  48. ----
    49. 

  49. 

  50. .. _class_InstancePlaceholder_method_get_instance_path:
    51. 

  51. 

  52. - :ref:`String<class_String>` **get_instance_path** **(** **)** const
    53. 

  53. 

  54. Retrieve the path to the :ref:`PackedScene<class_PackedScene>` resource file that is loaded by default when calling :ref:`replace_by_instance<class_InstancePlaceholder_method_replace_by_instance>`.
    55. 

  55. 

  56. ----
    57. 

  57. 

  58. .. _class_InstancePlaceholder_method_get_stored_values:
    59. 

  59. 

  60. - :ref:`Dictionary<class_Dictionary>` **get_stored_values** **(** :ref:`bool<class_bool>` with_order=false **)**
    61. 

  61. 

  62. ----
    63. 

  63. 

  64. .. _class_InstancePlaceholder_method_replace_by_instance:
    65. 

  65. 

  66. - void **replace_by_instance** **(** :ref:`PackedScene<class_PackedScene>` custom_scene=null **)**
    67. 

  67. 

  68. Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided.
    69. 

  69.