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
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_instanceplaceholder.rst

class_instanceplaceholder.rst 4.5 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InstancePlaceholder.xml.
    7. 

  7. 

  8. .. _class_InstancePlaceholder:
    9. 

  9. 

  10. InstancePlaceholder
    11. 

  11. ===================
    12. 

  12. 

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

  14. 

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

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

  20. Turning on the option **Load As Placeholder** for an instantiated scene in the editor causes it to be replaced by an ``InstancePlaceholder`` when running the game, this will not replace the node in the editor. This makes it possible to delay actually loading the scene until calling :ref:`create_instance<class_InstancePlaceholder_method_create_instance>`. This is useful to avoid loading large scenes all at once by loading parts of it selectively.
    21. 

  21. 

  22. The ``InstancePlaceholder`` does not have a transform. This causes any child nodes to be positioned relatively to the :ref:`Viewport<class_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.
    23. 

  23. 

  24. Methods
    25. 

  25. -------
    26. 

  26. 

  27. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :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 **)** |
    29. 

  29. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`String<class_String>`         | :ref:`get_instance_path<class_InstancePlaceholder_method_get_instance_path>` **(** **)** |const|                                                                                    |
    31. 

  31. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

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

  33. +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. 

  35. Method Descriptions
    36. 

  36. -------------------
    37. 

  37. 

  38. .. _class_InstancePlaceholder_method_create_instance:
    39. 

  39. 

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

  41. 

  42. Not thread-safe. Use :ref:`Object.call_deferred<class_Object_method_call_deferred>` if calling from a thread.
    43. 

  43. 

  44. ----
    45. 

  45. 

  46. .. _class_InstancePlaceholder_method_get_instance_path:
    47. 

  47. 

  48. - :ref:`String<class_String>` **get_instance_path** **(** **)** |const|
    49. 

  49. 

  50. Gets the path to the :ref:`PackedScene<class_PackedScene>` resource file that is loaded by default when calling :ref:`create_instance<class_InstancePlaceholder_method_create_instance>`. Not thread-safe. Use :ref:`Object.call_deferred<class_Object_method_call_deferred>` if calling from a thread.
    51. 

  51. 

  52. ----
    53. 

  53. 

  54. .. _class_InstancePlaceholder_method_get_stored_values:
    55. 

  55. 

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

  57. 

  58. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    59. 

  59. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    60. 

  60. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    61. 

  61. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    62. 

  62. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    63. 

  63. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    64.