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: ace47f729c
Branches Tags
godot-docs
/
classes
/
class_scenestate.rst

class_scenestate.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the SceneState.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_SceneState:
    6. 

  6. 

  7. SceneState
    8. 

  8. ==========
    9. 

  9. 

  10. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. 

  18. 

  19. Member Functions
    20. 

  20. ----------------
    21. 

  21. 

  22. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`Array<class_array>`                      | :ref:`get_connection_binds<class_SceneState_get_connection_binds>`  **(** :ref:`int<class_int>` idx  **)** const                                       |
    24. 

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

  25. | :ref:`int<class_int>`                          | :ref:`get_connection_count<class_SceneState_get_connection_count>`  **(** **)** const                                                                  |
    26. 

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

  27. | :ref:`int<class_int>`                          | :ref:`get_connection_flags<class_SceneState_get_connection_flags>`  **(** :ref:`int<class_int>` idx  **)** const                                       |
    28. 

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

  29. | :ref:`String<class_string>`                    | :ref:`get_connection_method<class_SceneState_get_connection_method>`  **(** :ref:`int<class_int>` idx  **)** const                                     |
    30. 

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

  31. | :ref:`String<class_string>`                    | :ref:`get_connection_signal<class_SceneState_get_connection_signal>`  **(** :ref:`int<class_int>` idx  **)** const                                     |
    32. 

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

  33. | :ref:`NodePath<class_nodepath>`                | :ref:`get_connection_source<class_SceneState_get_connection_source>`  **(** :ref:`int<class_int>` idx  **)** const                                     |
    34. 

  34. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`NodePath<class_nodepath>`                | :ref:`get_connection_target<class_SceneState_get_connection_target>`  **(** :ref:`int<class_int>` idx  **)** const                                     |
    36. 

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

  37. | :ref:`int<class_int>`                          | :ref:`get_node_count<class_SceneState_get_node_count>`  **(** **)** const                                                                              |
    38. 

  38. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`PoolStringArray<class_poolstringarray>`  | :ref:`get_node_groups<class_SceneState_get_node_groups>`  **(** :ref:`int<class_int>` idx  **)** const                                                 |
    40. 

  40. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`PackedScene<class_packedscene>`          | :ref:`get_node_instance<class_SceneState_get_node_instance>`  **(** :ref:`int<class_int>` idx  **)** const                                             |
    42. 

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

  43. | :ref:`String<class_string>`                    | :ref:`get_node_instance_placeholder<class_SceneState_get_node_instance_placeholder>`  **(** :ref:`int<class_int>` idx  **)** const                     |
    44. 

  44. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`String<class_string>`                    | :ref:`get_node_name<class_SceneState_get_node_name>`  **(** :ref:`int<class_int>` idx  **)** const                                                     |
    46. 

  46. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | :ref:`NodePath<class_nodepath>`                | :ref:`get_node_owner_path<class_SceneState_get_node_owner_path>`  **(** :ref:`int<class_int>` idx  **)** const                                         |
    48. 

  48. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | :ref:`NodePath<class_nodepath>`                | :ref:`get_node_path<class_SceneState_get_node_path>`  **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` for_parent=false  **)** const           |
    50. 

  50. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`int<class_int>`                          | :ref:`get_node_property_count<class_SceneState_get_node_property_count>`  **(** :ref:`int<class_int>` idx  **)** const                                 |
    52. 

  52. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`String<class_string>`                    | :ref:`get_node_property_name<class_SceneState_get_node_property_name>`  **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx  **)** const   |
    54. 

  54. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. | :ref:`Variant<class_variant>`                  | :ref:`get_node_property_value<class_SceneState_get_node_property_value>`  **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx  **)** const |
    56. 

  56. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. | :ref:`String<class_string>`                    | :ref:`get_node_type<class_SceneState_get_node_type>`  **(** :ref:`int<class_int>` idx  **)** const                                                     |
    58. 

  58. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59. | :ref:`bool<class_bool>`                        | :ref:`is_node_instance_placeholder<class_SceneState_is_node_instance_placeholder>`  **(** :ref:`int<class_int>` idx  **)** const                       |
    60. 

  60. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. 

  62. Numeric Constants
    63. 

  63. -----------------
    64. 

  64. 

  65. - **GEN_EDIT_STATE_DISABLED** = **0**
    66. 

  66. - **GEN_EDIT_STATE_INSTANCE** = **1**
    67. 

  67. - **GEN_EDIT_STATE_MAIN** = **2**
    68. 

  68. 

  69. Member Function Description
    70. 

  70. ---------------------------
    71. 

  71. 

  72. .. _class_SceneState_get_connection_binds:
    73. 

  73. 

  74. - :ref:`Array<class_array>`  **get_connection_binds**  **(** :ref:`int<class_int>` idx  **)** const
    75. 

  75. 

  76. .. _class_SceneState_get_connection_count:
    77. 

  77. 

  78. - :ref:`int<class_int>`  **get_connection_count**  **(** **)** const
    79. 

  79. 

  80. .. _class_SceneState_get_connection_flags:
    81. 

  81. 

  82. - :ref:`int<class_int>`  **get_connection_flags**  **(** :ref:`int<class_int>` idx  **)** const
    83. 

  83. 

  84. .. _class_SceneState_get_connection_method:
    85. 

  85. 

  86. - :ref:`String<class_string>`  **get_connection_method**  **(** :ref:`int<class_int>` idx  **)** const
    87. 

  87. 

  88. .. _class_SceneState_get_connection_signal:
    89. 

  89. 

  90. - :ref:`String<class_string>`  **get_connection_signal**  **(** :ref:`int<class_int>` idx  **)** const
    91. 

  91. 

  92. .. _class_SceneState_get_connection_source:
    93. 

  93. 

  94. - :ref:`NodePath<class_nodepath>`  **get_connection_source**  **(** :ref:`int<class_int>` idx  **)** const
    95. 

  95. 

  96. .. _class_SceneState_get_connection_target:
    97. 

  97. 

  98. - :ref:`NodePath<class_nodepath>`  **get_connection_target**  **(** :ref:`int<class_int>` idx  **)** const
    99. 

  99. 

  100. .. _class_SceneState_get_node_count:
    101. 

  101. 

  102. - :ref:`int<class_int>`  **get_node_count**  **(** **)** const
    103. 

  103. 

  104. .. _class_SceneState_get_node_groups:
    105. 

  105. 

  106. - :ref:`PoolStringArray<class_poolstringarray>`  **get_node_groups**  **(** :ref:`int<class_int>` idx  **)** const
    107. 

  107. 

  108. .. _class_SceneState_get_node_instance:
    109. 

  109. 

  110. - :ref:`PackedScene<class_packedscene>`  **get_node_instance**  **(** :ref:`int<class_int>` idx  **)** const
    111. 

  111. 

  112. .. _class_SceneState_get_node_instance_placeholder:
    113. 

  113. 

  114. - :ref:`String<class_string>`  **get_node_instance_placeholder**  **(** :ref:`int<class_int>` idx  **)** const
    115. 

  115. 

  116. .. _class_SceneState_get_node_name:
    117. 

  117. 

  118. - :ref:`String<class_string>`  **get_node_name**  **(** :ref:`int<class_int>` idx  **)** const
    119. 

  119. 

  120. .. _class_SceneState_get_node_owner_path:
    121. 

  121. 

  122. - :ref:`NodePath<class_nodepath>`  **get_node_owner_path**  **(** :ref:`int<class_int>` idx  **)** const
    123. 

  123. 

  124. .. _class_SceneState_get_node_path:
    125. 

  125. 

  126. - :ref:`NodePath<class_nodepath>`  **get_node_path**  **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` for_parent=false  **)** const
    127. 

  127. 

  128. .. _class_SceneState_get_node_property_count:
    129. 

  129. 

  130. - :ref:`int<class_int>`  **get_node_property_count**  **(** :ref:`int<class_int>` idx  **)** const
    131. 

  131. 

  132. .. _class_SceneState_get_node_property_name:
    133. 

  133. 

  134. - :ref:`String<class_string>`  **get_node_property_name**  **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx  **)** const
    135. 

  135. 

  136. .. _class_SceneState_get_node_property_value:
    137. 

  137. 

  138. - :ref:`Variant<class_variant>`  **get_node_property_value**  **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx  **)** const
    139. 

  139. 

  140. .. _class_SceneState_get_node_type:
    141. 

  141. 

  142. - :ref:`String<class_string>`  **get_node_type**  **(** :ref:`int<class_int>` idx  **)** const
    143. 

  143. 

  144. .. _class_SceneState_is_node_instance_placeholder:
    145. 

  145. 

  146. - :ref:`bool<class_bool>`  **is_node_instance_placeholder**  **(** :ref:`int<class_int>` idx  **)** const
    147. 

  147. 

  148.