Difference between revisions of "Include Element"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Low Post
(Added some Notes)
Tag: Manual revert
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The Include element has special meaning for the Oblivion XML parser, similar to that of the ''include'' statement in C-style programming languages.  An <include> element must be empty (no child elements or text/numerical contents), and it must have a '''src''' trait specified:
The Include element has special meaning for the Oblivion XML parser, similar to that of the ''include'' statement in C-style programming languages.  An <include> element must be empty (no child elements or text/numerical contents), and it must have a [[XML Attribute|src]] attribute specified:
  &lt;!-- Includes the xml code for a generic clickable button --&gt;
  &lt;!-- Includes the xml code for a generic clickable button --&gt;
  <include src="button_floating.xml" />
  <include src="button_floating.xml" />
Here the value of the '''src''' trait is the name of the xml file to include (relative to ''Oblivion\Data\Menus\Prefabs'').  Each time the parser finds an <include> element, it replaces it with the contents of this file before continuing.
The value of '''src''' is the name of the xml file to include (relative to ''Oblivion\Data\Menus\Prefabs'').  Each time the parser finds an <include> element, it replaces it with the contents of this file before continuing.


=== Notes ===
=== Notes ===
*This  is a bit different from the standard usage of the [[Trait|src trait]] with [[Operator Element]]s, where '''src''' refers to another element rather than a file.
*This  is a bit different from the standard usage of the [[XML Attribute|src]] attribute in [[Operator Element|Operator Elements]].  With operators, '''src'' refers to another element by name and is paired with a [[XML Attribute|trait]] attribute.  With Include, it refers to a file and appears by itself.
*Attempting to include a file that doesn't exist with cause a CTD.
*Attempting to include a file that doesn't exist with cause a CTD.
:*The file path is relative to '''Menus\prefabs\'''
*Spaces are '''not''' allowed in the file path.
:*Spaces are '''not''' allowed in the file path.


[[Category:Oblivion XML]]
[[Category:Oblivion XML]]

Latest revision as of 13:24, 21 December 2023

The Include element has special meaning for the Oblivion XML parser, similar to that of the include statement in C-style programming languages. An <include> element must be empty (no child elements or text/numerical contents), and it must have a src attribute specified:

<!-- Includes the xml code for a generic clickable button -->
<include src="button_floating.xml" />

The value of src is the name of the xml file to include (relative to Oblivion\Data\Menus\Prefabs). Each time the parser finds an <include> element, it replaces it with the contents of this file before continuing.

Notes[edit | edit source]

  • This is a bit different from the standard usage of the src attribute in Operator Elements. With operators, 'src refers to another element by name and is paired with a trait attribute. With Include, it refers to a file and appears by itself.
  • Attempting to include a file that doesn't exist with cause a CTD.
  • Spaces are not allowed in the file path.