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

class_xmlparser.rst 10 KB
Permalink History Raw

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

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_XMLParser:
    5. 

  5. 

  6. XMLParser
    7. 

  7. =========
    8. 

  8. 

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

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. Low-level class for creating parsers for XML files.
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | :ref:`int<class_int>`        | :ref:`get_attribute_count<class_XMLParser_get_attribute_count>`  **(** **)** const                                                         |
    23. 

  23. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`String<class_string>`  | :ref:`get_attribute_name<class_XMLParser_get_attribute_name>`  **(** :ref:`int<class_int>` idx  **)** const                                |
    25. 

  25. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`String<class_string>`  | :ref:`get_attribute_value<class_XMLParser_get_attribute_value>`  **(** :ref:`int<class_int>` idx  **)** const                              |
    27. 

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

  28. | :ref:`int<class_int>`        | :ref:`get_current_line<class_XMLParser_get_current_line>`  **(** **)** const                                                               |
    29. 

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

  30. | :ref:`String<class_string>`  | :ref:`get_named_attribute_value<class_XMLParser_get_named_attribute_value>`  **(** :ref:`String<class_string>` name  **)** const           |
    31. 

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

  32. | :ref:`String<class_string>`  | :ref:`get_named_attribute_value_safe<class_XMLParser_get_named_attribute_value_safe>`  **(** :ref:`String<class_string>` name  **)** const |
    33. 

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

  34. | :ref:`String<class_string>`  | :ref:`get_node_data<class_XMLParser_get_node_data>`  **(** **)** const                                                                     |
    35. 

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

  36. | :ref:`String<class_string>`  | :ref:`get_node_name<class_XMLParser_get_node_name>`  **(** **)** const                                                                     |
    37. 

  37. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`int<class_int>`        | :ref:`get_node_offset<class_XMLParser_get_node_offset>`  **(** **)** const                                                                 |
    39. 

  39. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`int<class_int>`        | :ref:`get_node_type<class_XMLParser_get_node_type>`  **(** **)**                                                                           |
    41. 

  41. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`bool<class_bool>`      | :ref:`has_attribute<class_XMLParser_has_attribute>`  **(** :ref:`String<class_string>` name  **)** const                                   |
    43. 

  43. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`bool<class_bool>`      | :ref:`is_empty<class_XMLParser_is_empty>`  **(** **)** const                                                                               |
    45. 

  45. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`int<class_int>`        | :ref:`open<class_XMLParser_open>`  **(** :ref:`String<class_string>` file  **)**                                                           |
    47. 

  47. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`int<class_int>`        | :ref:`open_buffer<class_XMLParser_open_buffer>`  **(** :ref:`RawArray<class_rawarray>` buffer  **)**                                       |
    49. 

  49. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`int<class_int>`        | :ref:`read<class_XMLParser_read>`  **(** **)**                                                                                             |
    51. 

  51. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`int<class_int>`        | :ref:`seek<class_XMLParser_seek>`  **(** :ref:`int<class_int>` pos  **)**                                                                  |
    53. 

  53. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | void                         | :ref:`skip_section<class_XMLParser_skip_section>`  **(** **)**                                                                             |
    55. 

  55. +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. 

  57. Numeric Constants
    58. 

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

  59. 

  60. - **NODE_NONE** = **0** --- There's no node (no file or buffer opened)
    61. 

  61. - **NODE_ELEMENT** = **1** --- Element (tag)
    62. 

  62. - **NODE_ELEMENT_END** = **2** --- End of element
    63. 

  63. - **NODE_TEXT** = **3** --- Text node
    64. 

  64. - **NODE_COMMENT** = **4** --- Comment node
    65. 

  65. - **NODE_CDATA** = **5** --- CDATA content
    66. 

  66. - **NODE_UNKNOWN** = **6** --- Unknown node
    67. 

  67. 

  68. Description
    69. 

  69. -----------
    70. 

  70. 

  71. This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema.
    72. 

  72. 

  73. Member Function Description
    74. 

  74. ---------------------------
    75. 

  75. 

  76. .. _class_XMLParser_get_attribute_count:
    77. 

  77. 

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

  79. 

  80. Get the amount of attributes in the current element.
    81. 

  81. 

  82. .. _class_XMLParser_get_attribute_name:
    83. 

  83. 

  84. - :ref:`String<class_string>`  **get_attribute_name**  **(** :ref:`int<class_int>` idx  **)** const
    85. 

  85. 

  86. Get the name of the attribute specified by the index in ``idx`` argument.
    87. 

  87. 

  88. .. _class_XMLParser_get_attribute_value:
    89. 

  89. 

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

  91. 

  92. Get the value of the attribute specified by the index in ``idx`` argument.
    93. 

  93. 

  94. .. _class_XMLParser_get_current_line:
    95. 

  95. 

  96. - :ref:`int<class_int>`  **get_current_line**  **(** **)** const
    97. 

  97. 

  98. Get the current line in the parsed file (currently not implemented).
    99. 

  99. 

  100. .. _class_XMLParser_get_named_attribute_value:
    101. 

  101. 

  102. - :ref:`String<class_string>`  **get_named_attribute_value**  **(** :ref:`String<class_string>` name  **)** const
    103. 

  103. 

  104. Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute.
    105. 

  105. 

  106. .. _class_XMLParser_get_named_attribute_value_safe:
    107. 

  107. 

  108. - :ref:`String<class_string>`  **get_named_attribute_value_safe**  **(** :ref:`String<class_string>` name  **)** const
    109. 

  109. 

  110. Get the value of a certain attribute of the current element by name. This will return an empty :ref:`String<class_string>` if the attribute is not found.
    111. 

  111. 

  112. .. _class_XMLParser_get_node_data:
    113. 

  113. 

  114. - :ref:`String<class_string>`  **get_node_data**  **(** **)** const
    115. 

  115. 

  116. Get the contents of a text node. This will raise an error in any other type of node.
    117. 

  117. 

  118. .. _class_XMLParser_get_node_name:
    119. 

  119. 

  120. - :ref:`String<class_string>`  **get_node_name**  **(** **)** const
    121. 

  121. 

  122. Get the name of the current element node. This will raise an error if the current node type is not ``NODE_ELEMENT`` nor ``NODE_ELEMENT_END``
    123. 

  123. 

  124. .. _class_XMLParser_get_node_offset:
    125. 

  125. 

  126. - :ref:`int<class_int>`  **get_node_offset**  **(** **)** const
    127. 

  127. 

  128. Get the byte offset of the current node since the beginning of the file or buffer.
    129. 

  129. 

  130. .. _class_XMLParser_get_node_type:
    131. 

  131. 

  132. - :ref:`int<class_int>`  **get_node_type**  **(** **)**
    133. 

  133. 

  134. Get the type of the current node. Compare with ``NODE\_\*`` constants.
    135. 

  135. 

  136. .. _class_XMLParser_has_attribute:
    137. 

  137. 

  138. - :ref:`bool<class_bool>`  **has_attribute**  **(** :ref:`String<class_string>` name  **)** const
    139. 

  139. 

  140. Check whether or not the current element has a certain attribute.
    141. 

  141. 

  142. .. _class_XMLParser_is_empty:
    143. 

  143. 

  144. - :ref:`bool<class_bool>`  **is_empty**  **(** **)** const
    145. 

  145. 

  146. Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>).
    147. 

  147. 

  148. .. _class_XMLParser_open:
    149. 

  149. 

  150. - :ref:`int<class_int>`  **open**  **(** :ref:`String<class_string>` file  **)**
    151. 

  151. 

  152. Open a XML file for parsing. This returns an error code.
    153. 

  153. 

  154. .. _class_XMLParser_open_buffer:
    155. 

  155. 

  156. - :ref:`int<class_int>`  **open_buffer**  **(** :ref:`RawArray<class_rawarray>` buffer  **)**
    157. 

  157. 

  158. Open a XML raw buffer for parsing. This returns an error code.
    159. 

  159. 

  160. .. _class_XMLParser_read:
    161. 

  161. 

  162. - :ref:`int<class_int>`  **read**  **(** **)**
    163. 

  163. 

  164. Read the next node of the file. This returns an error code.
    165. 

  165. 

  166. .. _class_XMLParser_seek:
    167. 

  167. 

  168. - :ref:`int<class_int>`  **seek**  **(** :ref:`int<class_int>` pos  **)**
    169. 

  169. 

  170. Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code.
    171. 

  171. 

  172. .. _class_XMLParser_skip_section:
    173. 

  173. 

  174. - void  **skip_section**  **(** **)**
    175. 

  175. 

  176. Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element.
    177. 

  177. 

  178.