Skip to content

Latest commit

 

History

History
56 lines (56 loc) · 2.54 KB

README.md

File metadata and controls

56 lines (56 loc) · 2.54 KB
Raw

BlueprintXML - Documentation

Documentation for the BlueprintXML plugin available on the Unreal Engine Marketplace.

Working Examples

Simple XML Loading from a file

Load XML example

Simple XML Save to file

Save XML to File example

Classes

XmlFile

A class representing an XML file. It contains a root node used to access the whole XML tree.

Methods

Get Last Error

  • Output Error FString The last error that occured for this XML file.

Is Valid

  • Output Is Valid boolean If this file has been successfully parsed and thus, it's safe to access its root node.

Get Root Node

  • Output Is Valid boolean If this root node is valid and can be accessed.
  • Output Root Node XmlNode This file's root node.

XmlNode

A class representing an XML node (a tag).

Methods

Find Child Node

  • Input Tag FString The tag we are looking for.
  • Output Found boolean If the wanted child was found.
  • Output Child Node XmlNode The found direct child node or nullptr.

Get Children Node

  • Output Out Nodes TArray<XmlNode> All this node's direct children.

Get First Child Node

  • Output First Child XmlNode This node's first child.

Get Next Node

  • Output Next Node XmlNode The next node on the same level as this node.

Get Attribute

  • Input In Tag FString The attribute we want to get.
  • Output Attribute FString This attribute's value.

Get Attributes

  • Output Attributes TMap<FString> All the attributes of this node.

Get Content

  • Output Content FString This node's content.

Get Tag

  • Output Tag FString This node's tag.

Set Content

  • Input Content FString This node's new content.

Append Child Node

  • Input Tag FString The new child node's tag.
  • Input Content FString The new child node's content.

Custom Nodes

These nodes are asynchronous and perform the heavy operation outside of the game thread.

Load XML File Async

  • Input File Path FString The path of the file we want to load.
  • Output XmlFile XmlFile The new virtual XML file created.

Load XML String Async

  • Input Xml String FString A string containing raw XML code.
  • Output XmlFile XmlFile The new virtual XML file created.

Save XML File Async

  • Input File to Save XmlFile The XmlFile we want to save to disk.
  • Input Path FString The location we want to save this file to.