Difference between revisions of "Property Element"

Properties which any object element of any type might define.

Properties which any object element of any type might define.

*'''ID''' (Numeric) Specifies which part of the internal menu "class" the element corresponds to, for the purposes of updating and accepting player input.  For example, the game treats whatever element has an ID of 3  in the Recharge menu as the exit button, regardless of the type, name, or any other property of the element - if it can be clicked on, then doing so will close the menu.  Likewise, the element with ID 2 in the Enchantment Settings menu is treated as the effect icon and will have its filename property updated by the game (even if it shouldn't have one).  Valid ID values depend on the menu class, but generally range 1-20.  Giving an element an ID not recognized for that menu will have no effect, while changing an existing ID will prevent the element from updating or accepting input.

*'''ID''' (Numeric) Specifies which part of the internal menu "class" the element corresponds to, for the purposes of updating and accepting player input.  For example, the game treats whatever element has an ID of 3  in the Recharge menu as the exit button, regardless of the type, name, or any other property of the element - if it can be clicked on, then doing so will close the menu.  Likewise, the element with ID 2 in the Enchantment Settings menu is treated as the effect icon and will have its filename property updated by the game (even if it shouldn't have one).  Valid ID values depend on the menu class, but generally range 1-20.  Giving an element an ID not recognized for that menu will have no effect, while changing an existing ID will prevent the element from updating or accepting input.

*'''User#''' (type flexible) Element types beginning in "user" are not in general part of the Oblivion XML schema.  They may, however, be recognized by specific menu classes and set to specific values.  For example, in most contexts an element of type User4 would be parsed and then ignored.  The internal class of the Spellmaking menu, though, will look for a User4 property element that is a child of the root [[Object Element#Menu|Menu element]], and update its value to the current magicka cost.

*'''User#''' (type flexible) Element types beginning in "user" are not in general part of the Oblivion XML schema.  They may, however, be recognized by specific menu classes and set to specific values.  For example, in most contexts an element of type User4 would be parsed and then ignored.  The internal class of the Spellmaking menu, though, will look for a User4 property element that is a child of the root [[Object Element#Menu|Menu element]], and update its value to the current magicka cost.

           Hello World

           Hello World

*'''Wrapwidth''' (Numeric) the maximum width, in pixels, of the element.  If the text is long enough to extend past this width, it is split into multiple lines.  This is the only way to control the size of a text element - the width and height properties set by the game engine to whatever the final dimensions of the element end up being.

*'''Wrapwidth''' (Numeric) the maximum width, in pixels, of the element.  If the text is long enough to extend past this width, it is split into multiple lines.  This is the only way to control the size of a text element - the width and height properties set by the game engine to whatever the final dimensions of the element end up being.

*'''IsHTML''' (Numeric) If value is greater than zero, the String Property is [[Book Formatting|parsed as HTML]] before being displayed.  ''Note'': This only works if the String property is set by script or the game engine, as HTML-formatted text written directly in the *.xml file is not handled correctly.

*'''IsHTML''' (Numeric) If value is greater than zero, the String Property is [[Book Formatting|parsed as HTML]] before being displayed.  ''Note'': This only works if the String property is set by script or the game engine, as HTML-formatted text written directly in the *.xml file is not handled correctly.

*'''PageNum''' (Numeric) In Oblivion, html-formatted text may be broken into pages using the <hr> tag.  This property specifies which 'page' of text is actually displayed, with zero meaning the first page, 1 meaning the second page, and so on.

*'''PageNum''' (Numeric) In Oblivion, html-formatted text may be broken into pages using the <hr> tag.  This property specifies which 'page' of text is actually displayed, with zero meaning the first page, 1 meaning the second page, and so on.