Property Element

Property Elements are a subgroup of the elements in the Oblivion XML schema, always found as children of Menu Elements. Loosely put, property elements define the properties of their parent element - position on the screen, color, texture, etc. In this sense they are similar to traditional xml traits.

There are two basic data types for properties - numeric and string. A number of Oblivion-specific XML entities are defined for commonly used constants of both types. Particularly useful are the numeric entities &true; and &false;, used to simulate boolean properties.

Property elements may contain literal values, or a set of Operator Elements as children (but not both). When the menu is rendered, the Oblivion parser evaluates each property element to obtain the value of the property (see the operator element page for a description on how they are evaluated). If a menu element contains more than one property element of the same type, the last one defined will take precedence. If it contains no property elements for an applicable property, the default value is used (usually zero or the empty string).

General

Properties which any menu element of any type might define.

• ID
• User#

Sizeable

Properties defining the size and screen position of a menu element, and possibly its children.

• X,Y
• Height, Width
• Locus

Rendered

Properties for any menu element with a visible effect, i.e. Image and Text elements. Note, however, that setting the Visible property to false on any element will hide all of it's children.

• Visible
• Alpha
• Depth
• Clips

Mouse Targetable

Properties for any menu elements that can be the focus of mouse events, i.e. the Image and Rect elements.

• Target
• Clicksound
• Mouseover

Textured

Properties specific to the Image Element

• Filename
• Zoom
• CropX,CropY

Text

Properties specific to the Text Element

• Red, Green Blue
• Font
• Justify
• String
• Wrapwidth

Menu

Properties specific to the Menu Element

• Class (Numeric) Specifies which internal menu "class" to use for handling input & output to the menu. Values match those returned by MenuMode, but are generally specified using a set of XML entities closely based on the menu name (e.g. "&RechargeMenu;" for the Recharge menu, with numerical value 1049). Values for which no internal menu class exists (like zero) will result in a "dead" menu - the menu will open, but will not be updated or accept input.
• Stackingtype (Numeric) Specifies whether or not the menu blocks the use of other menus and or the gameplay controls while open. Most menus do; only the HUD and the magic effects popup do not by default. Possible values are "&no_click_past;" (numerical value 6006) and "&does_not_stack;" (6008), although any value other than 6006 appears to cause non-blocking behavior.
• Menufade (Numeric) Specifies the duration (in seconds) of the "fade in" and "fade out" effect when the menu is opened and closed, respectively. While fading, the menu is open but does not update or accept input.