class_scenestate.rst 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  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_SceneState:
  4. SceneState
  5. ==========
  6. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`Array<class_array>` | :ref:`get_connection_binds<class_SceneState_get_connection_binds>` **(** :ref:`int<class_int>` idx **)** const |
  14. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_connection_count<class_SceneState_get_connection_count>` **(** **)** const |
  16. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_connection_flags<class_SceneState_get_connection_flags>` **(** :ref:`int<class_int>` idx **)** const |
  18. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`String<class_string>` | :ref:`get_connection_method<class_SceneState_get_connection_method>` **(** :ref:`int<class_int>` idx **)** const |
  20. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`String<class_string>` | :ref:`get_connection_signal<class_SceneState_get_connection_signal>` **(** :ref:`int<class_int>` idx **)** const |
  22. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`NodePath<class_nodepath>` | :ref:`get_connection_source<class_SceneState_get_connection_source>` **(** :ref:`int<class_int>` idx **)** const |
  24. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`NodePath<class_nodepath>` | :ref:`get_connection_target<class_SceneState_get_connection_target>` **(** :ref:`int<class_int>` idx **)** const |
  26. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`int<class_int>` | :ref:`get_node_count<class_SceneState_get_node_count>` **(** **)** const |
  28. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`StringArray<class_stringarray>` | :ref:`get_node_groups<class_SceneState_get_node_groups>` **(** :ref:`int<class_int>` idx **)** const |
  30. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`PackedScene<class_packedscene>` | :ref:`get_node_instance<class_SceneState_get_node_instance>` **(** :ref:`int<class_int>` idx **)** const |
  32. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`String<class_string>` | :ref:`get_node_instance_placeholder<class_SceneState_get_node_instance_placeholder>` **(** :ref:`int<class_int>` idx **)** const |
  34. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`String<class_string>` | :ref:`get_node_name<class_SceneState_get_node_name>` **(** :ref:`int<class_int>` idx **)** const |
  36. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`NodePath<class_nodepath>` | :ref:`get_node_owner_path<class_SceneState_get_node_owner_path>` **(** :ref:`int<class_int>` idx **)** const |
  38. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :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 |
  40. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`get_node_property_count<class_SceneState_get_node_property_count>` **(** :ref:`int<class_int>` idx **)** const |
  42. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :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 |
  44. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`get_node_property_value<class_SceneState_get_node_property_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx **)** const |
  46. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`String<class_string>` | :ref:`get_node_type<class_SceneState_get_node_type>` **(** :ref:`int<class_int>` idx **)** const |
  48. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`bool<class_bool>` | :ref:`is_node_instance_placeholder<class_SceneState_is_node_instance_placeholder>` **(** :ref:`int<class_int>` idx **)** const |
  50. +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. Member Function Description
  52. ---------------------------
  53. .. _class_SceneState_get_connection_binds:
  54. - :ref:`Array<class_array>` **get_connection_binds** **(** :ref:`int<class_int>` idx **)** const
  55. .. _class_SceneState_get_connection_count:
  56. - :ref:`int<class_int>` **get_connection_count** **(** **)** const
  57. .. _class_SceneState_get_connection_flags:
  58. - :ref:`int<class_int>` **get_connection_flags** **(** :ref:`int<class_int>` idx **)** const
  59. .. _class_SceneState_get_connection_method:
  60. - :ref:`String<class_string>` **get_connection_method** **(** :ref:`int<class_int>` idx **)** const
  61. .. _class_SceneState_get_connection_signal:
  62. - :ref:`String<class_string>` **get_connection_signal** **(** :ref:`int<class_int>` idx **)** const
  63. .. _class_SceneState_get_connection_source:
  64. - :ref:`NodePath<class_nodepath>` **get_connection_source** **(** :ref:`int<class_int>` idx **)** const
  65. .. _class_SceneState_get_connection_target:
  66. - :ref:`NodePath<class_nodepath>` **get_connection_target** **(** :ref:`int<class_int>` idx **)** const
  67. .. _class_SceneState_get_node_count:
  68. - :ref:`int<class_int>` **get_node_count** **(** **)** const
  69. .. _class_SceneState_get_node_groups:
  70. - :ref:`StringArray<class_stringarray>` **get_node_groups** **(** :ref:`int<class_int>` idx **)** const
  71. .. _class_SceneState_get_node_instance:
  72. - :ref:`PackedScene<class_packedscene>` **get_node_instance** **(** :ref:`int<class_int>` idx **)** const
  73. .. _class_SceneState_get_node_instance_placeholder:
  74. - :ref:`String<class_string>` **get_node_instance_placeholder** **(** :ref:`int<class_int>` idx **)** const
  75. .. _class_SceneState_get_node_name:
  76. - :ref:`String<class_string>` **get_node_name** **(** :ref:`int<class_int>` idx **)** const
  77. .. _class_SceneState_get_node_owner_path:
  78. - :ref:`NodePath<class_nodepath>` **get_node_owner_path** **(** :ref:`int<class_int>` idx **)** const
  79. .. _class_SceneState_get_node_path:
  80. - :ref:`NodePath<class_nodepath>` **get_node_path** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` for_parent=false **)** const
  81. .. _class_SceneState_get_node_property_count:
  82. - :ref:`int<class_int>` **get_node_property_count** **(** :ref:`int<class_int>` idx **)** const
  83. .. _class_SceneState_get_node_property_name:
  84. - :ref:`String<class_string>` **get_node_property_name** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx **)** const
  85. .. _class_SceneState_get_node_property_value:
  86. - void **get_node_property_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx **)** const
  87. .. _class_SceneState_get_node_type:
  88. - :ref:`String<class_string>` **get_node_type** **(** :ref:`int<class_int>` idx **)** const
  89. .. _class_SceneState_is_node_instance_placeholder:
  90. - :ref:`bool<class_bool>` **is_node_instance_placeholder** **(** :ref:`int<class_int>` idx **)** const