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

class_xmlparser.rst 12 KB
History Raw

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

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

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

  4. 

  5. .. _class_XMLParser:
    6. 

  6. 

  7. XMLParser
    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. Low-level class for creating parsers for XML files.
    18. 

  18. 

  19. Methods
    20. 

  20. -------
    21. 

  21. 

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

  23. | :ref:`int<class_int>`                    | :ref:`get_attribute_count<class_XMLParser_method_get_attribute_count>` **(** **)** const                                                        |
    24. 

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

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

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

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

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

  29. | :ref:`int<class_int>`                    | :ref:`get_current_line<class_XMLParser_method_get_current_line>` **(** **)** const                                                              |
    30. 

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

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

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

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

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

  35. | :ref:`String<class_String>`              | :ref:`get_node_data<class_XMLParser_method_get_node_data>` **(** **)** const                                                                    |
    36. 

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

  37. | :ref:`String<class_String>`              | :ref:`get_node_name<class_XMLParser_method_get_node_name>` **(** **)** const                                                                    |
    38. 

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

  39. | :ref:`int<class_int>`                    | :ref:`get_node_offset<class_XMLParser_method_get_node_offset>` **(** **)** const                                                                |
    40. 

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

  41. | :ref:`NodeType<enum_XMLParser_NodeType>` | :ref:`get_node_type<class_XMLParser_method_get_node_type>` **(** **)**                                                                          |
    42. 

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

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

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

  45. | :ref:`bool<class_bool>`                  | :ref:`is_empty<class_XMLParser_method_is_empty>` **(** **)** const                                                                              |
    46. 

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

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

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

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

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

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

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

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

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

  55. | void                                     | :ref:`skip_section<class_XMLParser_method_skip_section>` **(** **)**                                                                            |
    56. 

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

  57. 

  58. Enumerations
    59. 

  59. ------------
    60. 

  60. 

  61. .. _enum_XMLParser_NodeType:
    62. 

  62. 

  63. .. _class_XMLParser_constant_NODE_NONE:
    64. 

  64. 

  65. .. _class_XMLParser_constant_NODE_ELEMENT:
    66. 

  66. 

  67. .. _class_XMLParser_constant_NODE_ELEMENT_END:
    68. 

  68. 

  69. .. _class_XMLParser_constant_NODE_TEXT:
    70. 

  70. 

  71. .. _class_XMLParser_constant_NODE_COMMENT:
    72. 

  72. 

  73. .. _class_XMLParser_constant_NODE_CDATA:
    74. 

  74. 

  75. .. _class_XMLParser_constant_NODE_UNKNOWN:
    76. 

  76. 

  77. enum **NodeType**:
    78. 

  78. 

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

  80. 

  81. - **NODE_ELEMENT** = **1** --- Element (tag)
    82. 

  82. 

  83. - **NODE_ELEMENT_END** = **2** --- End of element
    84. 

  84. 

  85. - **NODE_TEXT** = **3** --- Text node
    86. 

  86. 

  87. - **NODE_COMMENT** = **4** --- Comment node
    88. 

  88. 

  89. - **NODE_CDATA** = **5** --- CDATA content
    90. 

  90. 

  91. - **NODE_UNKNOWN** = **6** --- Unknown node
    92. 

  92. 

  93. Description
    94. 

  94. -----------
    95. 

  95. 

  96. 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.
    97. 

  97. 

  98. Method Descriptions
    99. 

  99. -------------------
    100. 

  100. 

  101. .. _class_XMLParser_method_get_attribute_count:
    102. 

  102. 

  103. - :ref:`int<class_int>` **get_attribute_count** **(** **)** const
    104. 

  104. 

  105. Get the amount of attributes in the current element.
    106. 

  106. 

  107. .. _class_XMLParser_method_get_attribute_name:
    108. 

  108. 

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

  110. 

  111. Get the name of the attribute specified by the index in ``idx`` argument.
    112. 

  112. 

  113. .. _class_XMLParser_method_get_attribute_value:
    114. 

  114. 

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

  116. 

  117. Get the value of the attribute specified by the index in ``idx`` argument.
    118. 

  118. 

  119. .. _class_XMLParser_method_get_current_line:
    120. 

  120. 

  121. - :ref:`int<class_int>` **get_current_line** **(** **)** const
    122. 

  122. 

  123. Get the current line in the parsed file (currently not implemented).
    124. 

  124. 

  125. .. _class_XMLParser_method_get_named_attribute_value:
    126. 

  126. 

  127. - :ref:`String<class_String>` **get_named_attribute_value** **(** :ref:`String<class_String>` name **)** const
    128. 

  128. 

  129. 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.
    130. 

  130. 

  131. .. _class_XMLParser_method_get_named_attribute_value_safe:
    132. 

  132. 

  133. - :ref:`String<class_String>` **get_named_attribute_value_safe** **(** :ref:`String<class_String>` name **)** const
    134. 

  134. 

  135. 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.
    136. 

  136. 

  137. .. _class_XMLParser_method_get_node_data:
    138. 

  138. 

  139. - :ref:`String<class_String>` **get_node_data** **(** **)** const
    140. 

  140. 

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

  142. 

  143. .. _class_XMLParser_method_get_node_name:
    144. 

  144. 

  145. - :ref:`String<class_String>` **get_node_name** **(** **)** const
    146. 

  146. 

  147. 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``
    148. 

  148. 

  149. .. _class_XMLParser_method_get_node_offset:
    150. 

  150. 

  151. - :ref:`int<class_int>` **get_node_offset** **(** **)** const
    152. 

  152. 

  153. Get the byte offset of the current node since the beginning of the file or buffer.
    154. 

  154. 

  155. .. _class_XMLParser_method_get_node_type:
    156. 

  156. 

  157. - :ref:`NodeType<enum_XMLParser_NodeType>` **get_node_type** **(** **)**
    158. 

  158. 

  159. Get the type of the current node. Compare with ``NODE_*`` constants.
    160. 

  160. 

  161. .. _class_XMLParser_method_has_attribute:
    162. 

  162. 

  163. - :ref:`bool<class_bool>` **has_attribute** **(** :ref:`String<class_String>` name **)** const
    164. 

  164. 

  165. Check whether or not the current element has a certain attribute.
    166. 

  166. 

  167. .. _class_XMLParser_method_is_empty:
    168. 

  168. 

  169. - :ref:`bool<class_bool>` **is_empty** **(** **)** const
    170. 

  170. 

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

  172. 

  173. .. _class_XMLParser_method_open:
    174. 

  174. 

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

  176. 

  177. Open a XML file for parsing. This returns an error code.
    178. 

  178. 

  179. .. _class_XMLParser_method_open_buffer:
    180. 

  180. 

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

  182. 

  183. Open a XML raw buffer for parsing. This returns an error code.
    184. 

  184. 

  185. .. _class_XMLParser_method_read:
    186. 

  186. 

  187. - :ref:`Error<enum_@GlobalScope_Error>` **read** **(** **)**
    188. 

  188. 

  189. Read the next node of the file. This returns an error code.
    190. 

  190. 

  191. .. _class_XMLParser_method_seek:
    192. 

  192. 

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

  194. 

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

  196. 

  197. .. _class_XMLParser_method_skip_section:
    198. 

  198. 

  199. - void **skip_section** **(** **)**
    200. 

  200. 

  201. 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.
    202. 

  202.