Virtual XML template

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

→ UI Tech. Details

Virtual XML templates (or deferred nodes) extend the Widget API by allowing widgets to inherit properties.

<Frame name="MyFrameTemplate" virtual="true" />
<Frame inherits="MyFrameTemplate" />

CreateFrame("Frame", nil, nil, "MyFrameTemplate")

Usage

• Add virtual="true" (and a name) in XML to any kind of <LayoutFrame>, <Animation> or <AnimationGroup>.
• New widgets may inherit templates using a comma-delimited list of template names:
  • The inherits="" attribute in XML.
  • The fourth argument in CreateFrame().
• FrameXML provides numerous templates that AddOns may use, including:
  • A complete list (compiled by Ketho); and
  • Several basic widget appearances (SharedUIPanelTemplates.xml, archived at Townlong-Yak).

Details

• Templates do not reside in the global environment (_G) during runtime; they exist in a separate state.
• Reusing the same name on two virtual templates will throw a warning in Logs/FrameXML.log and in-game.

Patch changes

• Patch 8.0.1 (2018-07-17): Reusing the same template name now throws an in-game error.
  
• Patch 1.11.0 (2006-06-19): Now available during runtime through CreateFrame() or with LoadOnDemand.

  Templates previously existed only temporarily during the AddOn loading process
  

See also

• Intrinsic frame - Alternative means to extend the widget API.