class_nodepath.rst 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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_NodePath:
  4. NodePath
  5. ========
  6. **Category:** Built-In Types
  7. Brief Description
  8. -----------------
  9. Built-in type optimized for path traversing.
  10. Member Functions
  11. ----------------
  12. +----------------------------------+-----------------------------------------------------------------------------------------+
  13. | :ref:`String<class_string>` | :ref:`get_name<class_NodePath_get_name>` **(** :ref:`int<class_int>` idx **)** |
  14. +----------------------------------+-----------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_name_count<class_NodePath_get_name_count>` **(** **)** |
  16. +----------------------------------+-----------------------------------------------------------------------------------------+
  17. | :ref:`String<class_string>` | :ref:`get_property<class_NodePath_get_property>` **(** **)** |
  18. +----------------------------------+-----------------------------------------------------------------------------------------+
  19. | :ref:`String<class_string>` | :ref:`get_subname<class_NodePath_get_subname>` **(** :ref:`int<class_int>` idx **)** |
  20. +----------------------------------+-----------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_subname_count<class_NodePath_get_subname_count>` **(** **)** |
  22. +----------------------------------+-----------------------------------------------------------------------------------------+
  23. | :ref:`bool<class_bool>` | :ref:`is_absolute<class_NodePath_is_absolute>` **(** **)** |
  24. +----------------------------------+-----------------------------------------------------------------------------------------+
  25. | :ref:`bool<class_bool>` | :ref:`is_empty<class_NodePath_is_empty>` **(** **)** |
  26. +----------------------------------+-----------------------------------------------------------------------------------------+
  27. | :ref:`NodePath<class_nodepath>` | :ref:`NodePath<class_NodePath_NodePath>` **(** :ref:`String<class_string>` from **)** |
  28. +----------------------------------+-----------------------------------------------------------------------------------------+
  29. Description
  30. -----------
  31. Built-in type optimized for path traversing. A Node path is an optimized compiled path used for traversing the scene tree. It references nodes and can reference properties in that node, or even reference properties inside the resources of the node.
  32. Member Function Description
  33. ---------------------------
  34. .. _class_NodePath_get_name:
  35. - :ref:`String<class_string>` **get_name** **(** :ref:`int<class_int>` idx **)**
  36. Return a path level name.
  37. .. _class_NodePath_get_name_count:
  38. - :ref:`int<class_int>` **get_name_count** **(** **)**
  39. Return the path level count.
  40. .. _class_NodePath_get_property:
  41. - :ref:`String<class_string>` **get_property** **(** **)**
  42. Return the property associated (empty if none).
  43. .. _class_NodePath_get_subname:
  44. - :ref:`String<class_string>` **get_subname** **(** :ref:`int<class_int>` idx **)**
  45. Return the subname level name.
  46. .. _class_NodePath_get_subname_count:
  47. - :ref:`int<class_int>` **get_subname_count** **(** **)**
  48. Return the subname count.
  49. .. _class_NodePath_is_absolute:
  50. - :ref:`bool<class_bool>` **is_absolute** **(** **)**
  51. Return true if the node path is absolute (not relative).
  52. .. _class_NodePath_is_empty:
  53. - :ref:`bool<class_bool>` **is_empty** **(** **)**
  54. Return true if the node path is empty.
  55. .. _class_NodePath_NodePath:
  56. - :ref:`NodePath<class_nodepath>` **NodePath** **(** :ref:`String<class_string>` from **)**