Struct XmlParser

pub struct XmlParser { /* private fields */ }

Expand description

Godot class XMLParser.

Inherits RefCounted.

Related symbols:

xml_parser: sidecar module with related enum/flag types
IXmlParser: virtual methods

§Construction

This class is reference-counted. You can create a new instance using XmlParser::new_gd().

§Godot docs

Provides a low-level interface for creating parsers for XML files. This class can serve as base to make custom XML parsers.

To parse XML, you must open a file with the open method or a buffer with the open_buffer method. Then, the read method must be called to parse the next nodes. Most of the methods take into consideration the currently parsed node.

Here is an example of using XMLParser to parse an SVG file (which is based on XML), printing each element and its attributes as a dictionary:

var parser = XMLParser.new()
parser.open("path/to/file.svg")
while parser.read() != ERR_FILE_EOF:
	if parser.get_node_type() == XMLParser.NODE_ELEMENT:
		var node_name = parser.get_node_name()
		var attributes_dict = {}
		for idx in range(parser.get_attribute_count()):
			attributes_dict[parser.get_attribute_name(idx)] = parser.get_attribute_value(idx)
		print("The ", node_name, " element has the following attributes: ", attributes_dict)

Implementations§

§

impl XmlParser

pub fn read(&mut self) -> Error

Parses the next node in the file. This method returns an error code.

pub fn get_node_type(&self) -> NodeType

Returns the type of the current node. Compare with [enum NodeType] constants.

pub fn get_node_name(&self) -> GString

Returns the name of a node. This method will raise an error if the currently parsed node is a text node.

Note: The content of a NodeType::CDATA node and the comment string of a NodeType::COMMENT node are also considered names.

pub fn get_node_data(&self) -> GString

Returns the contents of a text node. This method will raise an error if the current parsed node is of any other type.

pub fn get_node_offset(&self) -> u64

Returns the byte offset of the currently parsed node since the beginning of the file or buffer. This is usually equivalent to the number of characters before the read position.

pub fn get_attribute_count(&self) -> i32

Returns the number of attributes in the currently parsed element.

Note: If this method is used while the currently parsed node is not NodeType::ELEMENT or NodeType::ELEMENT_END, this count will not be updated and will still reflect the last element.

pub fn get_attribute_name(&self, idx: i32) -> GString

Returns the name of an attribute of the currently parsed element, specified by the idx index.

pub fn get_attribute_value(&self, idx: i32) -> GString

Returns the value of an attribute of the currently parsed element, specified by the idx index.

pub fn has_attribute(&self, name: impl AsArg<GString>) -> bool

Returns true if the currently parsed element has an attribute with the name.

pub fn get_named_attribute_value(&self, name: impl AsArg<GString>) -> GString

Returns the value of an attribute of the currently parsed element, specified by its name. This method will raise an error if the element has no such attribute.

pub fn get_named_attribute_value_safe( &self, name: impl AsArg<GString>, ) -> GString

Returns the value of an attribute of the currently parsed element, specified by its name. This method will return an empty string if the element has no such attribute.

pub fn is_empty(&self) -> bool

Returns true if the currently parsed element is empty, e.g. <element />.

pub fn get_current_line(&self) -> i32

Returns the current line in the parsed file, counting from 0.

pub fn skip_section(&mut self)

Skips the current section. If the currently parsed node contains more inner nodes, they will be ignored and the cursor will go to the closing of the current element.

pub fn seek(&mut self, position: u64) -> Error

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

pub fn open(&mut self, file: impl AsArg<GString>) -> Error

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

pub fn open_buffer(&mut self, buffer: &PackedArray<u8>) -> Error

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

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Returns the current reference count.

Methods from Deref<Target = Object>§

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

Returns the object’s built-in class name, as a String. See also is_class.

Note: This method ignores class_name declarations. If this object’s script has defined a class_name, the base, built-in class name is returned instead.

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

Returns true if the object inherits from the given class. See also get_class.

var sprite2d = Sprite2D.new()
sprite2d.is_class("Sprite2D") # Returns true
sprite2d.is_class("Node")     # Returns true
sprite2d.is_class("Node3D")   # Returns false

Note: This method ignores class_name declarations in the object’s script.

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

Assigns value to the given property. If the property does not exist or the given value’s type doesn’t match, nothing happens.

var node = Node2D.new()
node.set("global_scale", Vector2(8, 2.5))
print(node.global_scale) # Prints (8.0, 2.5)

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

Returns the Variant value of the given property. If the property does not exist, this method returns null.

var node = Node2D.new()
node.rotation = 1.5
var a = node.get("rotation") # a is 1.5

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

Assigns a new value to the property identified by the property_path. The path should be a NodePath relative to this object, and can use the colon character (:) to access nested properties.

var node = Node2D.new()
node.set_indexed("position", Vector2(42, 0))
node.set_indexed("position:y", -10)
print(node.position) # Prints (42.0, -10.0)

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

Gets the object’s property indexed by the given property_path. The path should be a NodePath relative to the current object and can use the colon character (:) to access nested properties.

Examples: "position:x" or "material:next_pass:blend_mode".

var node = Node2D.new()
node.position = Vector2(5, -10)
var a = node.get_indexed("position")   # a is Vector2(5, -10)
var b = node.get_indexed("position:y") # b is -10

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

Note: This method does not support actual paths to nodes in the SceneTree, only sub-property paths. In the context of nodes, use get_node_and_resource instead.

pub fn get_property_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns the object’s property list as an Array of dictionaries. Each Dictionary contains the following entries:

name is the property’s name, as a String;
class_name is an empty StringName, unless the property is VariantType::OBJECT and it inherits from a class;
type is the property’s type, as an int (see [enum Variant.Type]);
hint is how the property is meant to be edited (see [enum PropertyHint]);
hint_string depends on the hint (see [enum PropertyHint]);
usage is a combination of [enum PropertyUsageFlags].

Note: In GDScript, all class members are treated as properties. In C# and GDExtension, it may be necessary to explicitly mark class members as Godot properties using decorators or attributes.

pub fn get_method_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns this object’s methods and their signatures as an Array of dictionaries. Each Dictionary contains the following entries:

name is the name of the method, as a String;
args is an Array of dictionaries representing the arguments;
default_args is the default arguments as an Array of variants;
flags is a combination of [enum MethodFlags];
id is the method’s internal identifier int;
return is the returned value, as a Dictionary;

Note: The dictionaries of args and return are formatted identically to the results of get_property_list, although not all entries are used.

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

Returns true if the given property has a custom default value. Use property_get_revert to get the property’s default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_can_revert] to customize the default value. If [method _property_can_revert] is not implemented, this method returns false.

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

Returns the custom default value of the given property. Use property_can_revert to check if the property has a custom default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_get_revert] to customize the default value. If [method _property_get_revert] is not implemented, this method returns null.

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

Adds or changes the entry name inside the object’s metadata. The metadata value can be any Variant, although some types cannot be serialized correctly.

If value is null, the entry is removed. This is the equivalent of using remove_meta. See also has_meta and get_meta.

Note: A metadata’s name must be a valid identifier as per is_valid_identifier method.