XMLParser

Inherits: Reference < Object

Low-level class for creating parsers for XML files.

Description

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.

Enumerations

enum NodeType:

  • NODE_NONE = 0 — There’s no node (no file or buffer opened).
  • NODE_ELEMENT = 1 — Element (tag).
  • NODE_ELEMENT_END = 2 — End of element.
  • NODE_TEXT = 3 — Text node.
  • NODE_COMMENT = 4 — Comment node.
  • NODE_CDATA = 5 — CDATA content.
  • NODE_UNKNOWN = 6 — Unknown node.

Method Descriptions

  • int get_attribute_count ( ) const

Gets the amount of attributes in the current element.


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


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


  • int get_current_line ( ) const

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


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.


Gets the value of a certain attribute of the current element by name. This will return an empty String if the attribute is not found.


  • String get_node_data ( ) const

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


  • String get_node_name ( ) const

Gets the name of the current element node. This will raise an error if the current node type is neither NODE_ELEMENT nor NODE_ELEMENT_END.


  • int get_node_offset ( ) const

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


Gets the type of the current node. Compare with NodeType constants.


Check whether the current element has a certain attribute.


  • bool is_empty ( ) const

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


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


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


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


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


  • void skip_section ( )

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.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.