Schema Settings

From VGInterface Wiki

The Settings element is used by parent elements to define properties of the element to the interpreter.

<VGUIWindow controlContainer="true">
		<Rect x="0" y="0" width="290" height="23"/>
		<Settings	visible="true"
				searchKey="_stat_details"/>

Contents 1 Elements 2 Attributes 3 SetRelationalPos 3.1 Elements 3.2 Attributes 4 RectMinSize 4.1 Elements 5 SetAnchors 5.1 Elements 5.2 Attributes 6 AddGameVariable 6.1 Attributes 7 Action 7.1 Elements 7.2 Attributes 8 SetTextOverlay 8.1 Attributes 9 Example Code

Elements

• Bind
• GraphicName
• SetSaveFileName - String
• SetLoadFileName - String
• SetRelationalPos
• RectMinSize
• SetAnchors
• AddGameVariable
• Action
• SetTextOverlay

Elements from SetRelationalPos to SetTextOverlay are complex types defined within the settings element. Their definitions can be found below.

Attributes

The Settings element contains the single most attributes of any element in the UI. As such, a further discussion of the purposes of each Settings Attribute can be found here.

• name - String
• skin - String
• background - Boolean
• searchKey - String
• hideFromStartList - Boolean
• visibilityGameVar - String
• enabledGameVar - String
• generateEventsWhenDisabled - Boolean
• sizeOnChildrenEdgeSpacing - Integer
• hideFromActiveWindows - Boolean
• setStoreInt - Integer
• setStoreInt2 - Integer
• enableMinSize - Boolean
• useColoredBackground - Boolean
• setBackgroundColor - String
• noMinimize - Boolean
• globalOpacity - String
• disabledOpacity - String
• mouseChangeOpacity - Boolean
• mouseChangeBackgroundOpacity - Boolean
• fontSize - Integer
• setBackgroundColorOpacity - Integer
• setMouseOverOpacity - Integer
• setMouseOffOpacity - Integer
• setMouseOverBackgroundOpacity - Integer
• setMouseOffBackgroundOpacity - Integer
• enableNonPrimaryFace - Boolean
• pulseMaxOpacity - Integer
• pulseMinOpacity - Integer
• allowPulse -Boolean
• setBackgroundOpacity - Integer
• visFadeInTime - Integer
• visFadeOutTime - Integer
• tabModeHideEdge - String
• enableSave - Boolean
• enableLoad - Boolean
• bringToFrontOnClick - Boolean
• primaryBringToFrontOnClick - Boolean
• toolTipOverride - String
• tooltip - String
• forceTooltipFollowMouse - Boolean
• forceTooltipReverseBias - Boolean
• hideFromPrimaryWindows - Boolean
• layoutMovable - Boolean
• layoutOutline - Boolean
• saveVisibility - Boolean
• escapeCloses - Boolean
• mouseCrossoverNotify - Boolean
• backgroundTexture - String
• movable - Boolean
• sizable - Boolean
• titlebar - Boolean
• closeBox - Boolean
• rollupBox - Boolean
• minimizeBox - Boolean
• border - String
• horizontalScroll - Boolean
• verticalScroll - Boolean
• minimized - Boolean
• visible - Boolean (default true)
• enabled - Boolean
• resizeOnChildren - Boolean
• canTriggerMove - Boolean
• mouseOnOverlay - Boolean
• customOverlay - String
• notifyOnDrag - Boolean
• notifyOnDragDrop - Boolean
• notifyOnLeftClick - Boolean
• notifyOnRightClick - Boolean
• notifyOnDoubleClick - Boolean
• notifyOnMove - Boolean
• clipping - Boolean
• clipChildren - Boolean
• alwaysUpdate - Boolean
• alwaysClickThrough - Boolean
• neverClickThrough - Boolean (default false)
• dropShadowText - Boolean
• defaultFocus - String
• disableRangeTooltip - Boolean
• alwaysCheckChildren - Boolean
• setBorderOpacity - Integer
• linkBorderOpacityToBackgroundOpacity - Boolean
• hideClickFromParent - Boolean

SetRelationalPos

Elements

• Edge - String
• Offset
  • Point
  • Size
  • widthMultiplier - Float
  • heightMultiplier - Float
• SiblingName - String

Attributes

• relationTo - String
• useWidthOffset - Boolean
• useHeightOffset - Boolean

RectMinSize

Elements

• Rect

SetAnchors

Elements

• LeftPercent - Integer
• RightPercent - Integer
• TopPercent - Integer
• BottomPercent - Integer

Attributes

• useAnchors - Boolean
• recalcOffsets - Boolean

AddGameVariable

Attributes

• gameVarLink - String

Action

Elements

• Notifications
  • Message - String

Attributes

• event - String
• senderName - String
• strData - String
• strData2 - String
• intData - Integer

SetTextOverlay

Attributes

• size - Integer
• color - String

Example Code

<Settings name=""
	    searchKey="_crafting_cancel_confirm"
	    visible="false"
	    background="true"
   	    visibilityGameVar="CraftingCancelConfirm"
	    setStoreInt="-1"
	    border="frame"
	    titlebar="true">

	<Action event="refining_cancel" senderName="_crafting_cancel_accept_button" intData="1">
		<Notifications>
			<Message>BUTTON_PRESS</Message>
		</Notifications>
	</Action>
	<Action event="refining_cancel" senderName="_crafting_cancel_cancel_button" intData="2">
		<Notifications>
			<Message>BUTTON_PRESS</Message>
		</Notifications>
	</Action>
								
</Settings>