Difference between revisions of "Property Element"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>JRoush
m (Value Element moved to Property Element: kept having to type "the value of the value element", which just sounds weird)
imported>JRoush
Line 1: Line 1:
{{unfinished}}
{{unfinished}}


Property Elements are a subgroup of the elements in the [[Oblivion XML]] schema, always found as children of [[Menu Element]]s.  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]].   
Property Elements are a subgroup of the elements in the [[:Category: Oblivion XML|Oblivion XML]] schema, always found as children of [[Menu Element]]s.  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 Element]]s 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).
Property elements may contain literal values, or a set of [[Operator Element]]s 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 ==
== General ==
Properties which any menu element of any type might define.
*ID
*ID
*User#
*User#


== Sizeable ==  
== Sizeable ==
Properties defining the size and screen position of a menu element, and possibly its children.
*X,Y
*X,Y
*Height, Width
*Height, Width
Line 15: Line 19:


== Visible ==
== Visible ==
Properties for any menu element with a visible effect, i.e. [[Menu Element#Image|Image]] and [[Menu Element#Text|Text]] elements. Note, however, that setting the Visible property to false on any element will hide all of it's children.
*Visible
*Alpha
*Alpha
*Depth
*Clips
*Clips
*Visible
*Depth


== Mouse Targetable ==
== Mouse Targetable ==
Properties for any menu elements that can be the focus of mouse events, i.e. the [[Menu Element#Image|Image]] and [[Menu Element#Rect|Rect]] elements.
*Target
*Target
*Clicksound
*Clicksound
Line 26: Line 32:


== Textured ==
== Textured ==
Properties specific to the [[Menu Element#Image|Image Element]]
*Filename
*Filename
*Zoom
*Zoom
Line 31: Line 38:


== Text ==
== Text ==
Properties specific to the [[Menu Element#Text|Text Element]]
*Red, Green Blue
*Red, Green Blue
*Font
*Font
Line 38: Line 46:


== Menu ==
== Menu ==
Properties specific to the [[Menu Element#Menu|Menu Element]]
*Class
*Class
*Stackingtype
*Stackingtype

Revision as of 19:57, 21 May 2009


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

Visible

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
  • Stackingtype
  • Menufade