Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 7a86ac6a30
Branches Tags
godot-docs
/
classes
/
class_xmlparser.rst

class_xmlparser.rst 12 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the XMLParser.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_XMLParser:
    8. 

  8. 

  9. XMLParser
    10. 

  10. =========
    11. 

  11. 

  12. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Low-level class for creating parsers for `XML <https://en.wikipedia.org/wiki/XML>`__ files.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. 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.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

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

  25. | :ref:`int<class_int>`                    | :ref:`get_attribute_count<class_XMLParser_method_get_attribute_count>` **(** **)** |const|                                                        |
    26. 

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

  27. | :ref:`String<class_String>`              | :ref:`get_attribute_name<class_XMLParser_method_get_attribute_name>` **(** :ref:`int<class_int>` idx **)** |const|                                |
    28. 

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

  29. | :ref:`String<class_String>`              | :ref:`get_attribute_value<class_XMLParser_method_get_attribute_value>` **(** :ref:`int<class_int>` idx **)** |const|                              |
    30. 

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

  31. | :ref:`int<class_int>`                    | :ref:`get_current_line<class_XMLParser_method_get_current_line>` **(** **)** |const|                                                              |
    32. 

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

  33. | :ref:`String<class_String>`              | :ref:`get_named_attribute_value<class_XMLParser_method_get_named_attribute_value>` **(** :ref:`String<class_String>` name **)** |const|           |
    34. 

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

  35. | :ref:`String<class_String>`              | :ref:`get_named_attribute_value_safe<class_XMLParser_method_get_named_attribute_value_safe>` **(** :ref:`String<class_String>` name **)** |const| |
    36. 

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

  37. | :ref:`String<class_String>`              | :ref:`get_node_data<class_XMLParser_method_get_node_data>` **(** **)** |const|                                                                    |
    38. 

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

  39. | :ref:`String<class_String>`              | :ref:`get_node_name<class_XMLParser_method_get_node_name>` **(** **)** |const|                                                                    |
    40. 

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

  41. | :ref:`int<class_int>`                    | :ref:`get_node_offset<class_XMLParser_method_get_node_offset>` **(** **)** |const|                                                                |
    42. 

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

  43. | :ref:`NodeType<enum_XMLParser_NodeType>` | :ref:`get_node_type<class_XMLParser_method_get_node_type>` **(** **)**                                                                            |
    44. 

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

  45. | :ref:`bool<class_bool>`                  | :ref:`has_attribute<class_XMLParser_method_has_attribute>` **(** :ref:`String<class_String>` name **)** |const|                                   |
    46. 

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

  47. | :ref:`bool<class_bool>`                  | :ref:`is_empty<class_XMLParser_method_is_empty>` **(** **)** |const|                                                                              |
    48. 

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

  49. | :ref:`Error<enum_@GlobalScope_Error>`    | :ref:`open<class_XMLParser_method_open>` **(** :ref:`String<class_String>` file **)**                                                             |
    50. 

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

  51. | :ref:`Error<enum_@GlobalScope_Error>`    | :ref:`open_buffer<class_XMLParser_method_open_buffer>` **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**                               |
    52. 

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

  53. | :ref:`Error<enum_@GlobalScope_Error>`    | :ref:`read<class_XMLParser_method_read>` **(** **)**                                                                                              |
    54. 

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

  55. | :ref:`Error<enum_@GlobalScope_Error>`    | :ref:`seek<class_XMLParser_method_seek>` **(** :ref:`int<class_int>` position **)**                                                               |
    56. 

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

  57. | void                                     | :ref:`skip_section<class_XMLParser_method_skip_section>` **(** **)**                                                                              |
    58. 

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

  59. 

  60. Enumerations
    61. 

  61. ------------
    62. 

  62. 

  63. .. _enum_XMLParser_NodeType:
    64. 

  64. 

  65. .. _class_XMLParser_constant_NODE_NONE:
    66. 

  66. 

  67. .. _class_XMLParser_constant_NODE_ELEMENT:
    68. 

  68. 

  69. .. _class_XMLParser_constant_NODE_ELEMENT_END:
    70. 

  70. 

  71. .. _class_XMLParser_constant_NODE_TEXT:
    72. 

  72. 

  73. .. _class_XMLParser_constant_NODE_COMMENT:
    74. 

  74. 

  75. .. _class_XMLParser_constant_NODE_CDATA:
    76. 

  76. 

  77. .. _class_XMLParser_constant_NODE_UNKNOWN:
    78. 

  78. 

  79. enum **NodeType**:
    80. 

  80. 

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

  82. 

  83. - **NODE_ELEMENT** = **1** --- Element (tag).
    84. 

  84. 

  85. - **NODE_ELEMENT_END** = **2** --- End of element.
    86. 

  86. 

  87. - **NODE_TEXT** = **3** --- Text node.
    88. 

  88. 

  89. - **NODE_COMMENT** = **4** --- Comment node.
    90. 

  90. 

  91. - **NODE_CDATA** = **5** --- CDATA content.
    92. 

  92. 

  93. - **NODE_UNKNOWN** = **6** --- Unknown node.
    94. 

  94. 

  95. Method Descriptions
    96. 

  96. -------------------
    97. 

  97. 

  98. .. _class_XMLParser_method_get_attribute_count:
    99. 

  99. 

  100. - :ref:`int<class_int>` **get_attribute_count** **(** **)** |const|
    101. 

  101. 

  102. Gets the amount of attributes in the current element.
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_XMLParser_method_get_attribute_name:
    107. 

  107. 

  108. - :ref:`String<class_String>` **get_attribute_name** **(** :ref:`int<class_int>` idx **)** |const|
    109. 

  109. 

  110. Gets the name of the attribute specified by the index in ``idx`` argument.
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_XMLParser_method_get_attribute_value:
    115. 

  115. 

  116. - :ref:`String<class_String>` **get_attribute_value** **(** :ref:`int<class_int>` idx **)** |const|
    117. 

  117. 

  118. Gets the value of the attribute specified by the index in ``idx`` argument.
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_XMLParser_method_get_current_line:
    123. 

  123. 

  124. - :ref:`int<class_int>` **get_current_line** **(** **)** |const|
    125. 

  125. 

  126. Gets the current line in the parsed file (currently not implemented).
    127. 

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_XMLParser_method_get_named_attribute_value:
    131. 

  131. 

  132. - :ref:`String<class_String>` **get_named_attribute_value** **(** :ref:`String<class_String>` name **)** |const|
    133. 

  133. 

  134. Gets the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute.
    135. 

  135. 

  136. ----
    137. 

  137. 

  138. .. _class_XMLParser_method_get_named_attribute_value_safe:
    139. 

  139. 

  140. - :ref:`String<class_String>` **get_named_attribute_value_safe** **(** :ref:`String<class_String>` name **)** |const|
    141. 

  141. 

  142. Gets 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.
    143. 

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_XMLParser_method_get_node_data:
    147. 

  147. 

  148. - :ref:`String<class_String>` **get_node_data** **(** **)** |const|
    149. 

  149. 

  150. Gets the contents of a text node. This will raise an error in any other type of node.
    151. 

  151. 

  152. ----
    153. 

  153. 

  154. .. _class_XMLParser_method_get_node_name:
    155. 

  155. 

  156. - :ref:`String<class_String>` **get_node_name** **(** **)** |const|
    157. 

  157. 

  158. Gets the name of the current element node. This will raise an error if the current node type is neither :ref:`NODE_ELEMENT<class_XMLParser_constant_NODE_ELEMENT>` nor :ref:`NODE_ELEMENT_END<class_XMLParser_constant_NODE_ELEMENT_END>`.
    159. 

  159. 

  160. ----
    161. 

  161. 

  162. .. _class_XMLParser_method_get_node_offset:
    163. 

  163. 

  164. - :ref:`int<class_int>` **get_node_offset** **(** **)** |const|
    165. 

  165. 

  166. Gets the byte offset of the current node since the beginning of the file or buffer.
    167. 

  167. 

  168. ----
    169. 

  169. 

  170. .. _class_XMLParser_method_get_node_type:
    171. 

  171. 

  172. - :ref:`NodeType<enum_XMLParser_NodeType>` **get_node_type** **(** **)**
    173. 

  173. 

  174. Gets the type of the current node. Compare with :ref:`NodeType<enum_XMLParser_NodeType>` constants.
    175. 

  175. 

  176. ----
    177. 

  177. 

  178. .. _class_XMLParser_method_has_attribute:
    179. 

  179. 

  180. - :ref:`bool<class_bool>` **has_attribute** **(** :ref:`String<class_String>` name **)** |const|
    181. 

  181. 

  182. Check whether the current element has a certain attribute.
    183. 

  183. 

  184. ----
    185. 

  185. 

  186. .. _class_XMLParser_method_is_empty:
    187. 

  187. 

  188. - :ref:`bool<class_bool>` **is_empty** **(** **)** |const|
    189. 

  189. 

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

  191. 

  192. ----
    193. 

  193. 

  194. .. _class_XMLParser_method_open:
    195. 

  195. 

  196. - :ref:`Error<enum_@GlobalScope_Error>` **open** **(** :ref:`String<class_String>` file **)**
    197. 

  197. 

  198. Opens an XML file for parsing. This returns an error code.
    199. 

  199. 

  200. ----
    201. 

  201. 

  202. .. _class_XMLParser_method_open_buffer:
    203. 

  203. 

  204. - :ref:`Error<enum_@GlobalScope_Error>` **open_buffer** **(** :ref:`PoolByteArray<class_PoolByteArray>` buffer **)**
    205. 

  205. 

  206. Opens an XML raw buffer for parsing. This returns an error code.
    207. 

  207. 

  208. ----
    209. 

  209. 

  210. .. _class_XMLParser_method_read:
    211. 

  211. 

  212. - :ref:`Error<enum_@GlobalScope_Error>` **read** **(** **)**
    213. 

  213. 

  214. Reads the next node of the file. This returns an error code.
    215. 

  215. 

  216. ----
    217. 

  217. 

  218. .. _class_XMLParser_method_seek:
    219. 

  219. 

  220. - :ref:`Error<enum_@GlobalScope_Error>` **seek** **(** :ref:`int<class_int>` position **)**
    221. 

  221. 

  222. Moves the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code.
    223. 

  223. 

  224. ----
    225. 

  225. 

  226. .. _class_XMLParser_method_skip_section:
    227. 

  227. 

  228. - void **skip_section** **(** **)**
    229. 

  229. 

  230. 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.
    231. 

  231. 

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

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

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

  235.