14 | 
15 | BlzCreateFrameByType Fails
9 | 10 | -------------------------------------------------------------------------------- /FrameTypes/SIMPLEFRAME.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Container of the SimpleFrame Family.
9 | 10 | -------------------------------------------------------------------------------- /Keywords/ID.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ID int,
9 |Example: ID 0,
10 |Purpose: No idea
11 |Used in:
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/TabFocusDefault.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TabFocusDefault,
9 |Purpose:
10 |Used in:
11 | 12 | -------------------------------------------------------------------------------- /FrameTypes/SLASHCHATBOX.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Unsure about the difference to EDITBOX
9 | -------------------------------------------------------------------------------- /Keywords/Checked.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Checked,
9 |Purpose: created in checked State
10 |Used in: GLUECHECKBOX, CHECKBOX
11 | 12 | -------------------------------------------------------------------------------- /FrameTypes/TIMERTEXT.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |I am not sure what the difference to TEXT is.
9 | 10 | -------------------------------------------------------------------------------- /Keywords/Width.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Width real,
9 |Example: Width 0.04
10 |Purpose: Initial Width
11 |Used in: EveryWhere
12 | 13 | -------------------------------------------------------------------------------- /Keywords/MenuBorder.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: MenuBorder real,
9 |Example: MenuBorder 0.01,
10 |Purpose:
11 |Used in: MENU
12 | 13 | -------------------------------------------------------------------------------- /FrameTypes/FRAME.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Basic container of the Frame Family, itself only Takes mouse control and can have tooltips. But does not support FrameEvents.
9 | 10 | -------------------------------------------------------------------------------- /Keywords/Height.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Height real,
10 |Example: Height 0.022,
11 |Purpose: Initial Size of a Frame.
12 |Used in: EveryWhere
13 | 14 | -------------------------------------------------------------------------------- /Keywords/SetAllPoints.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SetAllPoints,
9 |Purpose: Copies the Position and Size of the parent Frame.
10 |Used in: EveryWhere
11 | 12 | -------------------------------------------------------------------------------- /FrameTypes/GLUEEDITBOX.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Like EDITBOX, but has the heavy mouse click Sound when created with BlzCreateFrame.
9 | -------------------------------------------------------------------------------- /Keywords/ChatDisplayEditBox.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ChatDisplayEditBox
9 |Example: ChatDisplayEditBox
10 |Purpose:
11 |Used in:
12 | 13 | -------------------------------------------------------------------------------- /FrameTypes/GLUEPOPUPMENU.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Like POPUPMENU, but has the heavy mouse click Sound when created with BlzCreateFrame.
9 | -------------------------------------------------------------------------------- /Keywords/ChatDisplayScrollBar.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ChatDisplayScrollBar
9 |Example: ChatDisplayScrollBar
10 |Purpose:
11 |Used in:
12 | 13 | -------------------------------------------------------------------------------- /Keywords/SpriteCamera.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format1: SpriteCamera int,
9 |Example: SpriteCamera 0,
10 |Purpose: No Idea
11 |Used in: SPRITE, MODEL, STATUSBAR
12 | 13 | -------------------------------------------------------------------------------- /FrameTypes/GLUEBUTTON.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Like BUTTON, but has the heavy mouse click Sound when created with BlzCreateFrame.
9 | 10 | -------------------------------------------------------------------------------- /FrameTypes/GLUETEXTBUTTON.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Like TEXTBUTTON, but has the heavy mouse click Sound when created with BlzCreateFrame.
9 | -------------------------------------------------------------------------------- /Keywords/ChatDisplayLineHeight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ChatDisplayLineHeight
9 |Example: ChatDisplayLineHeight
10 |Purpose:
11 |Used in:
12 | 13 | -------------------------------------------------------------------------------- /Keywords/HighlightType.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |HighlightType "FILETEXTURE",
9 |Purpose:
10 |HighlightType "SHADE",
11 |Purpose:
12 |Used in: HIGHLIGHT
13 | 14 | -------------------------------------------------------------------------------- /Keywords/SliderLayoutVertical.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SliderLayoutVertical,
9 |Purpose: The Slider goes from Bottom(min) to Top(max)
10 |Used in: SLIDER
11 | 12 | -------------------------------------------------------------------------------- /Keywords/Text.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Text text,
9 |Example: Text "HIGH_LATENCY",
10 |Purpose: Initial TextValue. Tries to load a Localized String.
11 |Used in: TEXT, String
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropHalfSides.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropHalfSides,
9 |Example: BackdropHalfSides,
10 |Purpose: WhoKnows
11 |Used in: BACKDROP
12 | 13 | 14 | -------------------------------------------------------------------------------- /FrameTypes/GLUECHECKBOX.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Like CHECKBOX, but has the heavy mouse click Sound when created with BlzCreateFrame.
9 | 10 | -------------------------------------------------------------------------------- /Keywords/EditText.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditText text,
9 |Example: EditText "YES",
10 |Purpose: Initial Text in the EditBox
11 |Used in: GLUEEDITBOX, EDITBOX, SLASHCHATBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/File.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: File FilePath,
9 |Example: File "ReplayPanelBackdrop",
10 |Purpose: The file the Texture-ChildFrame displays.
11 |Used in: Texture(SIMPLEFRAME)
12 | 13 | -------------------------------------------------------------------------------- /Keywords/TextLength.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TextLength integer,
9 |Example: TextLength 8,
10 |Purpose: The String can only take that amount of digits
11 |Used in: String
12 | 13 | -------------------------------------------------------------------------------- /Keywords/SliderLayoutHorizontal.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SliderLayoutHorizontal,
9 |Purpose: Default, Slider goes from Left(min) to Right(max).
10 |Used in: SLIDER
11 | 12 | -------------------------------------------------------------------------------- /Keywords/SliderMinValue.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SliderMinValue integer,
9 |Example: SliderMinValue 0,
10 |Purpose: Default, 0. Min number chooseable
11 |Used in: SLIDER
12 | 13 | -------------------------------------------------------------------------------- /Keywords/CheckedTexture.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: CheckedTexture FileName,
9 |Example: CheckedTexture "ReplayCheckBoxCheck",
10 |Purpose:
11 |Used in: SIMPLECHECKBOX
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/MenuItemHeight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: MenuItemHeight real,
9 |Example: MenuItemHeight 0.014,
10 |Purpose: The height of the options of the MENU.
11 |Used in: MENU
12 | 13 | -------------------------------------------------------------------------------- /Keywords/SliderMaxValue.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SliderMaxValue integer,
9 |Example: SliderMaxValue 100,
10 |Purpose: Default, 100. Max number chooseable
11 |Used in: SLIDER
12 | 13 | -------------------------------------------------------------------------------- /Keywords/DoNotRegisterName.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: DoNotRegisterName,
9 |Purpose: This Frame is not added into the storage accessed by BlzGetFrameByName
10 |Used in: BACKDROP
11 | 12 | 13 | -------------------------------------------------------------------------------- /Keywords/SliderStepSize.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SliderStepSize integer,
9 |Example: SliderStepSize 1,
10 |Purpose: How accurate the user can choose values.
11 |Used in: SLIDER
12 | 13 | -------------------------------------------------------------------------------- /Keywords/TextAreaLineGap.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TextAreaLineGap real,
9 |Example: TextAreaLineGap 0.0015,
10 |Purpose: Adds space between 2 TextArea Lines.
11 |Used in: TEXTAREA
12 | 13 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |8 | 9 | 10 |
11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/ChatDisplayBorderSize.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ChatDisplayBorderSize real,
9 |Example: ChatDisplayBorderSize 0.01,
10 |Purpose: WhoKnows
11 |Used in: CHATDISPLAY
12 | 13 | -------------------------------------------------------------------------------- /Keywords/DialogBackdrop.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: DialogBackdrop FrameName,
9 |Example: DialogBackdrop "UnresponsiveBackdrop",
10 |Purpose: ControlBackdrop for DIALOG
11 |Used in: DIALOG
12 | 13 | -------------------------------------------------------------------------------- /Keywords/ListBoxStyle.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ListBoxStyle string,
9 |Example: ListBoxStyle "",
10 |Purpose: Listbox Flags unsure how they are called and what they do
11 |Used in: LISTBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/TabFocusNext.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TabFocusNext FrameName,
9 |Example: TabFocusNext "DeleteDeleteButton",
10 |Purpose: Give Focus to who when pressing Tab.
11 |Used in:
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/Alpha.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Alpha 0 to 255,
9 |Example: Alpha 100,
10 |Purpose: "calls" BlzFrameSetAlpha(this, value), makes the frame "transparent" or more stable
11 |Used in: everywhere
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/BackdropCornerSize.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropCornerSize real,
9 |Example: BackdropCornerSize 0.048,
10 |Purpose: Size of the border/edge.
11 |Used in: BACKDROP
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/ListBoxBorder.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ListBoxBorder real,
9 |Example: ListBoxBorder 0.01,
10 |Purpose: How big is the used border? Used to offset the ListItems
11 |Used in: LISTBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/ListBoxItemHeight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ListBoxItemHeight real,
9 |Example: ListBoxItemHeight 0.01,
10 |Purpose: How much Y-space takes one ListItem.
11 |Used in: LISTBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/StatusBarSprite.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: StatusBarSprite model,
9 |Example: StatusBarSprite "ui/feedback/XpBar/XpBarConsole.mdx",
10 |Purpose: Model display
11 |Used in: STATUSBAR
12 | 13 | -------------------------------------------------------------------------------- /Keywords/TabFocusPush.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TabFocusPush,
9 |Purpose: This somehow enables childFrames to use ControlShortcutKey. The childs have to be (GLUE)(TEXT)BUTTON.
10 |Used in: FRAME
11 | 12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropCornerFile.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropCornerFile FilePath,
9 |Example: BackdropCornerFile "UI\Widgets\ButtonCorners.blp",
10 |Purpose:
11 |Used in: BACKDROP
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/SliderInitialValue.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SliderInitialValue integer,
9 |Example: SliderInitialValue 2,
10 |Purpose: The Slider starts with that value.
11 |Used in: SLIDER
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackgroundArt.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackgroundArt FilePath,
9 |Example: BackgroundArt "UI\Glues\ScoreScreen\ScoreScreen-TopBar\ScoreScreen-TopBar.mdl",
10 |Purpose:
11 |Used in: MODEL, SPRITE
12 | 13 | -------------------------------------------------------------------------------- /Keywords/PopupButtonInset.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: PopupButtonInset real,
9 |Example: PopupButtonInset 0.01,
10 |Purpose: -x offset for PopupArrowFrame from RIGHT of the POPUPMENU
11 |Used in: POPUPMENU
12 | 13 | -------------------------------------------------------------------------------- /FrameTypes/SIMPLECHECKBOX.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Interactive of the SimpleFrame Family.
9 |I wasn't able to attach events nor get the value in any way last time I tested it (V1.31PTR), so it is kinda useless right now.
10 | 11 | -------------------------------------------------------------------------------- /Keywords/EditBorderSize.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditBorderSize real,
9 |Example: EditBorderSize 0.009,
10 |Purpose: Offsets Text by that amount from the border
11 |Used in: EDITBOX, GLUEEDITBOX, SLASHCHATBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropMirrored.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropMirrored,
9 |Example: BackdropMirrored,
10 |Purpose: Vertical, a face looking to the left will look with this option to the right.
11 |Used in: BACKDROP
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropTopFile.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropTopFile FilePath,
9 |Example: BackdropTopFile "UI\Widgets\ButtonTop.blp",
10 |Purpose: Set the Texture for the top part of the Border
11 |Used in: BACKDROP
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropBackgroundSize.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropBackgroundSize real,
9 |Example: BackdropBackgroundSize 0.032,
10 |Purpose: in Tile mode, the size of each tile
11 |Used in: BACKDROP
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/DecorateFileNames.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: DecorateFileNames,
9 |Purpose: Inside this Frame FilePaths are looked up from StringLists. String and Texture take that from their Parent.
10 |Used in: Everywhere
11 | 12 | 13 | -------------------------------------------------------------------------------- /Keywords/PopupTitleFrame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: PopupTitleFrame FrameName,
9 |Example: PopupTitleFrame "EscOptionsShadowsPopupMenuTitle",
10 |Purpose: Choose a GLUETEXTBUTTON for the PopupMenu
11 |Used in: POPMENU
12 | 13 | -------------------------------------------------------------------------------- /Keywords/PushedTexture.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: PushedTexture Texture,
9 |Example: PushedTexture "UpperMenuButtonPushedBackground",
10 |Purpose:
11 |Can use NAMED
12 |Used in: SIMPLEBUTTON
13 | 14 | -------------------------------------------------------------------------------- /Keywords/TextAreaScrollBar.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TextAreaScrollBar FrameName,
9 |Example: TextAreaScrollBar "QuestDisplayScrollBar",
10 |Purpose: Choose the Frame handling the Scrollbar.
11 |Used in: TEXTAREA
12 | 13 | -------------------------------------------------------------------------------- /Keywords/EditTextFrame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditTextFrame FrameName,
9 |Example: EditTextFrame "SaveGameFileEditBoxText",
10 |Purpose: Style the Text of the EditBox. Expects a TEXT-Frame.
11 |Used in: EDITBOX, GLUEEDITBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/ListBoxScrollBar.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ListBoxScrollBar FrameName,
9 |Example: ListBoxScrollBar "StandardListBoxScrollBarTemplate",
10 |Purpose: Setup the Frame performing the Scrollbar.
11 |Used in: LISTBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/NormalText.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: NormalText FrameName text,
9 |Example: NormalText "UpperButtonBarButtonTextTemplate" "KEY_CHAT",
10 |Purpose:
11 |Can use NAMED
12 |Used in: SIMPLEBUTTON
13 | 14 | -------------------------------------------------------------------------------- /Keywords/BackdropRightFile.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropRightFile FilePath,
9 |Example: BackdropRightFile "UI\Widgets\ButtonRight.blp",
10 |Purpose: Set the Texture for the right part of the Border
11 |Used in: BACKDROP
12 | 13 | -------------------------------------------------------------------------------- /Keywords/Font.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Font FontName, real,
9 |Example: Font "InfoPanelTextFont", 0.009,
10 |Purpose: Styles the text of a String the Text-Child Frame of SIMPLEFRAME. String do not have a default Font.
11 |Used in: String(SIMPLEFRAME)
12 | 13 | -------------------------------------------------------------------------------- /Keywords/FrameFont.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FrameFont FontName, size, text,
9 |Example: FrameFont "MasterFont", 0.011, "",
10 |Purpose:
11 |Used in: MENU, TEXT, FRAME, TEXTAREA, GLUETEXTBUTTON, DIALOG, TEXTBUTTON, CHATDISPLAY, TIMERTEXT
12 | 13 | -------------------------------------------------------------------------------- /Keywords/SpriteScale.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format1: SpriteScale x x x,
9 |Example: SpriteScale 0.1 0 0,
10 |Purpose: Scales the used Model. The 2. and 3. number are fake and don't seem to do anything.
11 |Used in: SPRITE, MODEL, STATUSBAR
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropLeftFile.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropLeftFile FilePath,
10 |Example: BackdropLeftFile "UI\Widgets\ButtonLeft.blp",
11 |Purpose: Set the Texture for the left part of the Border
12 |Used in: BACKDROP
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/PopupArrowFrame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: PopupArrowFrame FrameName,
9 |Example: PopupArrowFrame "AdvancedPopupMenuArrow",
10 |Purpose: Choose the BUTTON-Frame of the POPUPMENU (the arrow at the right)
11 |Used in: POPUPMENU
12 | 13 | -------------------------------------------------------------------------------- /Keywords/PopupMenuFrame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: PopupMenuFrame FrameName,
9 |Example: PopupMenuFrame "RacePopupMenuMenu",
10 |Purpose: Choose the MENU for this POPMENU, the Menu contains the chooseable options.
11 |Used in: POPMENU
12 | 13 | -------------------------------------------------------------------------------- /Keywords/TextAreaMaxLines.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TextAreaMaxLines integer,
9 |Example: TextAreaMaxLines 128,
10 |Purpose: Only that amount of lines are displayed, if more lines are added oldest are removed.
11 |Used in: TEXTAREA
12 | 13 | -------------------------------------------------------------------------------- /Keywords/FontHeight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FontHeight real,
10 |Example: FontHeight 0.015,
11 |Purpose: Displays Text bigger/smaller, but drops quality. Better use FrameFont
12 | 13 |Used in: TEXT
14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /Keywords/BackdropBottomFile.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropBottomFile FilePath,
9 |Example: BackdropBottomFile "UI\Widgets\ButtonBottom.blp",
10 |Purpose: Set the Texture for the bottom part of the Border
11 |Used in: BACKDROP
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/BarTexture.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BarTexture FilePath,
9 |Example: BarTexture "SimpleBuildTimeIndicator",
10 |Purpose: Define the Texture filling the Frame from left to right, based on the value of the SIMPLESTATUSBAR.
11 |Used in: SIMPLESTATUSBAR
12 | 13 | -------------------------------------------------------------------------------- /Keywords/FontJustificationOffset.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FontJustificationOffset x y,
9 |Example: FontJustificationOffset 0.01 0.0,
10 |Purpose: Displays the Text with that offset to its frames position.
11 |Used in: TEXT, String
12 | 13 | -------------------------------------------------------------------------------- /Keywords/UseHighlight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: UseHighlight Texture,
9 |Example: UseHighlight "UpperMenuButtonHighlight",
10 |Purpose: Texture used for Highlight. SIMPLEBUTTON
11 |Can use NAMED
12 |Used in: SIMPLEBUTTON
13 | 14 | -------------------------------------------------------------------------------- /Keywords/HighlightAlphaMode.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: HighlightAlphaMode Text,
9 |Example: HighlightAlphaMode "ADD",
10 |Example: HighlightAlphaMode "BLEND",
11 |Purpose: Defines the display Type of the HIGHLIGHT.
12 |Used in: HIGHLIGHT
13 | 14 | -------------------------------------------------------------------------------- /Keywords/ScrollBarDecButtonFrame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ScrollBarDecButtonFrame FrameName,
9 |Example: ScrollBarDecButtonFrame "EscMenuScrollBarDecButton",
10 |Purpose: Choose a BUTTON handling the Dec click.
11 |Used in: SCROLLBAR
12 | 13 | -------------------------------------------------------------------------------- /Keywords/ScrollBarIncButtonFrame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ScrollBarIncButtonFrame FrameName,
9 |Example: ScrollBarIncButtonFrame "StandardScrollBarIncButton",
10 |Purpose: Choose a BUTTON handling the Inc click.
11 |Used in: SCROLLBAR
12 | 13 | -------------------------------------------------------------------------------- /Keywords/DialogOkButton.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: DialogOkButton FrameName,
9 |Example: DialogOkButton "MySimplyDialogOKButton",
10 |Purpose: GLUETEXTBUTTON for DIALOG used as ok. The GLUETEXTBUTTON has to be a direct child of the dialog.
11 |Used in: DIALOG
12 | 13 | -------------------------------------------------------------------------------- /Keywords/HighlightColor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: HighlightColor red green blue alph,
9 |Example: HighlightColor 1.0 0.0 0.0 0.2,
10 |Purpose: Appears together with HighlightType "SHADE",
11 |Used in: HIGHLIGHT
12 |the last value, alpha can be skiped
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/MenuTextHighlightColor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: MenuTextHighlightColor red green blue alpha,
9 |Example: MenuTextHighlightColor 0.99 0.827 0.0705 1.0,
10 |Purpose:
11 |Used in: MENU
12 |the last value, alpha can be skiped
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/Anchor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Anchor FramePoint,x,y,
9 |Example: Anchor TOPLEFT, 0.1, 0.1,
10 |Purpose: Set the position of a FramePoint to the same FramePoint of its parent with a x/y offset. One Texture/String can only use one Anchor.
11 |Used in: String, Texture
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/SliderThumbButtonFrame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SliderThumbButtonFrame FrameName,
9 |Example: SliderThumbButtonFrame "EscMenuScrollThumbButton",
10 |Purpose: Choose BUTTON used to move the SLIDER/SCROLLBAR Value.
11 |Used in: SLIDER, SCROLLBAR
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropBackground.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropBackground filepath,
9 |Example: BackdropBackground "UI\Widgets\Glues\GlueScreen-Button1-BackdropBackground.blp",
10 |Purpose: Defines the background/main texture of a BACKDROP
11 |Used in: BACKDROP
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/ControlPushedBackdrop.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ControlPushedBackdrop FrameName,
9 |Example: ControlPushedBackdrop "ButtonPushedBackdropTemplate",
10 |Purpose: Displayed when enabled and pushed
11 |Used in: BUTTON, GLUEBUTTON, TEXTBUTTON, GLUETEXTBUTTON
12 | 13 | -------------------------------------------------------------------------------- /Keywords/EditHighlightInitial.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditHighlightInitial,
9 |Purpose: The initial Text is marked. The Cursor FontSize and Text FontSize should match otherwise only a part of the initial text is marked.
10 |Used in: EDITBOX, GLUEEDITBOX, SLASHCHATBOX
11 | 12 | -------------------------------------------------------------------------------- /Keywords/FontShadowOffset.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FontShadowOffset x y,
9 |Example: FontShadowOffset 0.001 -0.001,
10 |Purpose: This is a relative offset to the default Text. The TextShadow can increse the readability and sharpness of Text.
11 |Used in: TEXT, String
12 | 13 | -------------------------------------------------------------------------------- /Keywords/DialogCancelButton.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: DialogCancelButton FrameName,
9 |Example: DialogCancelButton "ConfirmCancelButton",
10 |Purpose: GLUETEXTBUTTON for DIALOG used as cancel. The GLUETEXTBUTTON has to be a direct child of the dialog.
11 |Used in: DIALOG
12 | 13 | -------------------------------------------------------------------------------- /Keywords/DisabledTexture.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: DisabledTexture FrameName,
9 |Example: DisabledTexture "UpperMenuButtonDisabledBackground",
10 |Purpose: Defines the shown texture in disabled state.
11 |Can use NAMED
12 |Used in: SIMPLEBUTTON
13 | 14 | -------------------------------------------------------------------------------- /Keywords/TextAreaInset.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TextAreaInset real,
9 |Example: TextAreaInset 0.002,
10 |Purpose: Moves the Text and the scrollbar into the middle from all sides by this amount. This increases the min size for game crash by to small TEXTAREA.
11 |Used in: TEXTAREA
12 | 13 | -------------------------------------------------------------------------------- /Keywords/HighlightOutlineOffset.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: HighlightOutlineOffset x,
9 |Example: HighlightOutlineOffset 0.01,
10 |Purpose: Increases the x&y space the Highlight is displayed to. Best usage is -borderSize to not highlight the border.
11 |Used in: HIGHLIGHT
12 | 13 | -------------------------------------------------------------------------------- /Keywords/DisabledText.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: DisabledText FrameName Text,
9 |Example: DisabledText "UpperButtonBarButtonDisabledTextTemplate" "QUESTS",
10 |Purpose: Text displayed when the SIMPLEBUTTON is disabled.
11 |Can use NAMED
12 |Used in: SIMPLEBUTTON
13 | 14 | -------------------------------------------------------------------------------- /Keywords/EditCursorColor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditCursorColor red green blue alpha,
9 |Example: EditCursorColor 1.0 1.0 1.0,
10 |Purpose: Defines the color of the EditBox's Cursor | while it has focus. The alpha value can be skiped then it is 1.0.
11 |Used in: EDITBOX, GLUEEDITBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/ButtonText.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ButtonText FrameName,
9 |Example: ButtonText "HelpButtonText",
Frame "TEXT" "HelpButtonText" INHERITS "BattleNetButtonTextTemplate" {
10 |
Purpose: Define the TEXT-Frame styling the ButtonText.
12 |Used in: TEXTBUTTON, GLUETEXTBUTTON, SIMPLEBUTTON
13 | 14 | -------------------------------------------------------------------------------- /Keywords/EditTextOffset.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditTextOffset x y,
9 |Example: EditTextOffset 0.01 0.0,
10 |Purpose: Offsets the Text inside the Editbox, the Text can not leave the EditBox using this. If it would leave the text becomes "hidden".
11 |Used in: EDITBOX, GLUEEDITBOX, SLASHCHATBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/FontJustificationH.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |FontJustificationH JUSTIFYLEFT,
9 |FontJustificationH JUSTIFYCENTER,
10 |FontJustificationH JUSTIFYRIGHT,
11 |Purpose: When an TEXT frame is given a rect, it will pos the displayed text x wise at that TextJustify
12 |Used in: TEXT, String
13 | 14 | -------------------------------------------------------------------------------- /Keywords/FontJustificationV.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |FontJustificationV JUSTIFYTOP,
9 |FontJustificationV JUSTIFYMIDDLE,
10 |FontJustificationV JUSTIFYBOTTOM,
11 |Purpose: When an TEXT frame is given a rect, it will pos the displayed text y-wise at that TextJustify
12 |Used in: TEXT, String
13 | 14 | -------------------------------------------------------------------------------- /Keywords/UseActiveContext.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: UseActiveContext,
9 |Purpose: Alters the behaviour of SetPoint. It will connect to the relative Frame with the same CreateContext as the current Frame is created with.
10 |String and Texture take that from their Parent
11 | 12 | 13 | -------------------------------------------------------------------------------- /Keywords/EditTextHeight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditTextHeight real,
10 |Example: EditTextHeight 0.015,
11 |Purpose: Displays Text bigger/smaller, but drops quality and dismatches the cursor. Better use FrameFont
12 | 13 |Used in: EDITBOX, GLUEEDITBOX
14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /Keywords/TextAreaLineHeight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TextAreaLineHeight real,
9 |Example: TextAreaLineHeight 0.015,
10 |Purpose: How much space each line can take, if the used FontSize does not fit this the Text won't be displayed or there will be alot of space between Lines.
11 |Used in: TEXTAREA
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropBlendAll.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropBlendAll,
9 |Example: BackdropBlendAll,
10 |Purpose: Use transparency by alpha channels. An image with alpha channel transparency but without this, will be displayed wrong. Allows also to see the stuff below the Frame
11 |Used in: BACKDROP
12 | 13 | 14 | -------------------------------------------------------------------------------- /Keywords/Layer.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Layer Text open block
9 |Example: Layer "ARTWORK" {
10 |Example: Layer "ARTWORK_OVERLAY" {
11 |Example: Layer "BACKGROUND" {
12 |Purpose: Organize the order of Texture & String of SIMPLEFRAMEs.
13 |Used in: SIMPLEBUTTON, SIMPLECHECKBOX, SIMPLEFRAME, SIMPLESTATUSBAR
14 | 15 | -------------------------------------------------------------------------------- /Common/TOC.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |A TOC file contains a list, Each line is a path to a fdf (case is ignored) the fdfs are loaded when the TOC is executed.
9 |The TOC needs to end with one or two empty lines otherwise the last fdf line is not read.
10 |Probably means Table of Content (WaterKnight).
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/Keywords/EditTextColor.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Format: EditTextColor red green blue alpha,
9 |Example: EditTextColor 1.0 1.0 1.0,
10 |Purpose: Defines the color of the EditBox's Text. The alpha value can be skiped then it is 1.0. FontColor inside EditTextFrame is stronger.
11 |Used in: EDITBOX, GLUEEDITBOX, SLASHCHATBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/CursorSprite.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: CursorSprite model,
9 |Example: CursorSprite "UI/Cursor/NightElfCursor.mdx",
10 |Purpose: Changes the MouseCursor while it is in the Frame's controled space. Unsure how exactly it works, was only able to get the confirm target texture from the default cursors
11 |Used in:
12 | 13 | -------------------------------------------------------------------------------- /Keywords/HighlightText.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: HighlightText FrameName Text,
10 |Example: HighlightText "UpperButtonBarButtonHighlightTextTemplate" "KEY_CHAT",
11 |Purpose: This Text is displayed for the SIMPLEBUTTON, when focused.
12 |Can use NAMED
13 |Used in: SIMPLEBUTTON,
14 | 15 | -------------------------------------------------------------------------------- /Keywords/ListBoxItem.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ListBoxItem ADDEND, frameName,
9 |Example: ListBoxItem ADDEND, "MyListBoxItem",
10 |Purpose: Add child with frameName into the ListBox. The child has to be defined in a line above. There are other add Poins: ADDEND, ADDBEGINNING. The child loses its name.
11 |Used in: LISTBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropEdgeFile.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropEdgeFile FilePath,
10 |Example: BackdropEdgeFile "UI\Widgets\BattleNet\bnet-inputbox-border.blp",
11 |Purpose: Setup the BorderFile for that BACKDROP, this file contains all Parts of the Border as fragments next to each other
12 |Used in: BACKDROP
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/BackdropTileBackground.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropTileBackground,
9 |Example: BackdropTileBackground,
10 |Purpose: Fills the Frame with instances of the texture. Without the background file is stretched. One also should set BackdropBackgroundSize when using this feature.
11 |Used in: BACKDROP
12 | 13 | -------------------------------------------------------------------------------- /Keywords/ControlDisabledPushedBackdrop.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ControlDisabledPushedBackdrop FrameName,
9 |Example: ControlDisabledPushedBackdrop "ButtonDisabledPushedBackdropTemplate",
10 |Purpose: Displayed when disabled and pushed
11 |Used in: BUTTON, GLUEBUTTON, TEXTBUTTON, GLUETEXTBUTTON
12 | 13 | -------------------------------------------------------------------------------- /Keywords/FontCharSpacing.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FontCharSpacing real,
10 |Example: FontCharSpacing 2,
11 |Example: FontCharSpacing 0.5,
12 |Purpose: Displays whitespace between each char. The whitespace is FontSize*factor big. With 2 you have
13 |T e x t14 |
Used in: TEXT
15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /Keywords/FontShadowColor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FontShadowColor red green blue alpha
9 |Example: FontShadowColor 0.0 0.0 0.0 0.9,
10 |Purpose: In which color the Text's shadow is displayed. TextShadow is displayed behind the default Text.
11 |Used in: TEXT, String
12 |the last value, alpha can be skiped
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/ButtonPushedTextOffset.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ButtonPushedTextOffset real real,
10 |Example: ButtonPushedTextOffset -0.0015f -0.0015f,
11 |Purpose: Reposes the position of the ButtonText while beeing pressed down. One can skip the f behind a value.
12 |Used in: TEXTBUTTON, GLUETEXTBUTTON, SIMPLEBUTTON
13 | 14 | -------------------------------------------------------------------------------- /Keywords/EditSetFocus.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditSetFocus,
9 |Purpose: Gives this Frame focus when it is created. The focus given that way is quite strong clicking on the ground does not transfer focus nor does hiding it, But clicking onto another custom UI took it away and the focus became normal.
10 |Used in: EDITBOX, GLUEEDITBOX, SLASHCHATBOX
11 | 12 | -------------------------------------------------------------------------------- /Keywords/FontDisabledColor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FontDisabledColor red green blue alpha
9 |Example: FontDisabledColor 0.4 0.5 0.6 0.7,
10 |Purpose: Color of the text in disabled state. Can be skiped in which case the Text will be white or use FontColor if set.
11 |the last value, alpha can be skiped
12 |Used in: TEXT
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/FontHighlightColor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FontHighlightColor red green blue alpha,
9 |Example: FontHighlightColor 1.0 1.0 1.0 1.0,
10 |Purpose: Color of the text during focus. Can be skiped in which case the Text will be white or use FontColor if set.
11 |the last value, alpha can be skiped
12 |Used in: TEXT
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/NormalTexture.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: NormalTexture Texture,
9 |Example: NormalTexture "UpperMenuButtonBackground",
10 |Purpose: The displayed texture in enabled State, can be externalized into another frame to perform some advanced actions.
11 |Can use NAMED
12 |Used in: SIMPLEBUTTON, SIMPLECHECKBOX
13 | 14 | -------------------------------------------------------------------------------- /Keywords/EditHighlightColor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditHighlightColor red green blue alpha,
9 |Example: EditHighlightColor 1.0 1.0 1.0 0.5,
10 |Purpose: Color of the EditBox's Marked Text Box. Alpha should not be 1.0 because it makes the marked text unreadable. The alpha value can be skiped then it is 1.0.
11 |Used in: EDITBOX, GLUEEDITBOX, SLASHCHATBOX
12 | 13 | -------------------------------------------------------------------------------- /FrameTypes/SIMPLETOP.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |A simpletop controls interactivty and the layer order of simpleframes managed by it. A Simpletop is not the parent. It manages simpleframes but belongs to the Frame family.
9 |The offical Frame Api (V1.31.1) does not allow to choose/change the used simpletop, reforged has multiple. The one that starts "ConsoleUI" and the world-objects overlay.
10 | 11 | -------------------------------------------------------------------------------- /Keywords/String.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format1: String {}
9 |Format2: String "FrameName" {}
10 |Format3: String "FrameName" INHERITS "FrameNameInherited" {}
11 |Format4: String INHERITS "FrameNameInherited" {}
12 |Purpose: Defines a String-Frame, This is only used for SimpleFrames. It displays Text for SimpleFrames.
13 |Used in: SIMPLEBUTTON, SIMPLECHECKBOX, SIMPLEFRAME, SIMPLESTATUSBAR
14 | 15 | -------------------------------------------------------------------------------- /Keywords/EditMaxChars.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: EditMaxChars int,
9 |Example: EditMaxChars 11,
10 |Purpose: Can't write more than that amount of Chars into the EditBox. Chars that take more than one byte take multiple slots. For example 11 can be 1234567890A or ÄÄÄÄÄA as Ä take 2 bytes. Pasting text into with a longer text is rejected.
11 |Used in: EDITBOX, GLUEEDITBOX, SLASHCHATBOX
12 | 13 | 14 | -------------------------------------------------------------------------------- /FrameTypes/SIMPLESTATUSBAR.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |A SIMPLESTATUSBAR is a simple frame that shows a texture partly (from left to right) based on the SIMPLESTATUSBAR current value vs its max value. The Texture is stretched to the total frames size.
9 | 10 | 11 |Format: FontColor red green blue alpha,
9 |Example: FontColor 1.0 0.201 1.0 1.0,
10 |Purpose: Color of the text in enabled state. Can be skiped in which case the Text will be white. Text accpets coloring text with BlzFrameSetText having the warcraft 3 color code as prefix |cff0021ff.
11 |the last value, alpha can be skiped
12 |Used in: String, TEXT,
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/Texture.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: Texture FrameName INHERITS FrameName {
9 |Example: Texture "InfoPanelIconBackdrop" INHERITS "InfoPanelIconTemplate" {
10 |Example: Texture "SimpleBuildQueueBackdrop" {
11 |Purpose: A Texture is a child Frame used in Frames of category SIMPLE. It is used to display images for this group.
12 |Used in: SIMPLEFRAME, SIMPLEBUTTON, SIMPLECHECKBOX, SIMPLESTATUSBAR
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/CheckBoxCheckHighlight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: CheckBoxCheckHighlight FrameName,
10 |Example: CheckBoxCheckHighlight "BattleNetRadioButtonHighlightTemplate",
11 |Purpose: Frame beeing created that is used as CheckBoxCheckHighlight. It is a frame of type HIGHLIGHT and displays the beeing checked texture when the Checkbox is enabled.
12 |Used in: GLUECHECKBOX, CHECKBOX
13 | 14 | 15 | -------------------------------------------------------------------------------- /FrameTypes/SCROLLBAR.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Mostly used as functional child. For a non binded one use SLIDER.
9 | 10 |Like BUTTON but has a functional Text child which text is linked to the TEXTBUTTON
9 | 10 |Format: ControlFocusHighlight FrameName,
9 |Example: ControlFocusHighlight "IconicButtonFocusHighlightTemplate",
10 |Purpose: Define the HIGHLIGHT-Frame beeing displayed while the parentFrame has focus. A Button should have ControlStyle "HIGHLIGHTONFOCUS" to use this.
11 |Used in: BUTTON, GLUEBUTTON, TEXTBUTTON, GLUETEXTBUTTON
12 | 13 | -------------------------------------------------------------------------------- /Keywords/BackdropCornerFlags.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropCornerFlags Text,
10 |Example: BackdropCornerFlags "UL|UR|BL|BR|T|L|B|R", //Whole Border
11 |Example: BackdropCornerFlags "UL|UR|T|L|R", //No Bottom Border
12 |Purpose: EdgeFiles displayed, one can skip some and order does not matter. Using this without seting border files will crash the game when this Backdrop is displayed
13 |Used in: BACKDROP
14 | 15 | 16 | -------------------------------------------------------------------------------- /Keywords/ControlMouseOverHighlight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ControlMouseOverHighlight FrameName,
9 |Example: ControlMouseOverHighlight "BorderedButtonMouseOverHighlightTemplate",
10 |Purpose: Define the HIGHLIGHT-Frame beeing displayed while the parentFrame is hovered with the Mouse. A Button should have ControlStyle "HIGHLIGHTONMOUSEOVER" to use this.
11 |Used in: BUTTON, GLUEBUTTON, TEXTBUTTON, GLUETEXTBUTTON
12 | 13 | -------------------------------------------------------------------------------- /Keywords/CheckBoxDisabledCheckHighlight.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: CheckBoxDisabledCheckHighlight FrameName,
9 |Example: CheckBoxDisabledCheckHighlight "EscMenuDisabledCheckHighlightTemplate",
10 |Purpose: Same as CheckBoxCheckHighlight in disabled State, if none such Frame exists but the enabled was set the enabled version will be displayed in disabled State.
11 |Used in: GLUECHECKBOX, CHECKBOX
12 | 13 | 14 | -------------------------------------------------------------------------------- /FrameTypes/LISTBOXITEM.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |An item of a LISTBOX.
9 | 10 |Format: ControlDisabledBackdrop FrameName,
9 |Example: ControlDisabledBackdrop "ButtonDisabledBackdropTemplate",
10 |Purpose: BACKDROP when the parentFrame is disabled. Can be skiped in which case ControlBackdrop will be displayed even in Disabled State.
11 |Used in: MENU, POPUPMENU, BUTTON, GLUEBUTTON, TEXTBUTTON, GLUETEXTBUTTON, SCROLLBAR, SLIDER, CONTROL, TEXTAREA, EDITBOX, GLUEEDITBOX, GLUECHECKBOX, CHECKBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/LayerStyle.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |LayerStyle "NOSHADING|IGNORETRACKEVENTS", //Both
9 |LayerStyle "IGNORETRACKEVENTS",
10 |
Purpose: Does not trigger Frame Mouse events and can't be clicked.
LayerStyle "NOSHADING",
12 |
Purpose:
LayerStyle "SETSVIEWPORT",
14 |
Purpose: Limits the visuals of the Layer & SubLayers started by this frame to this frames taken space. The children are still interactive, even when not seeable at a spot.
Used in: EveryWhere
16 | 17 | 18 | -------------------------------------------------------------------------------- /Keywords/AlphaMode.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: AlphaMode Text,
9 |AlphaMode "ALPHAKEY",
10 |AlphaMode "ADD",
11 |AlphaMode "DISABLE",
12 |AlphaMode "BLEND",
13 |AlphaMode "MOD",
14 |Purpose: Changes the way transparency of the taken image is interpreted, changing the image during game with BlzFrameSetTexture overwrittes this value.
15 |Can be an optional arg in many Texture actions. NormalTexture "ADD","textures\zap1b",
16 |Used in: Texture(SIMPLEFRAME)
17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /Keywords/ControlBackdrop.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: ControlBackdrop FrameName,
9 |Example: ControlBackdrop "ButtonBackdropTemplate",
10 |Purpose: Mimic Position and Size of the parent Frame. It is the texture displayed when the parent-Frame is enabled Is the name of the frame beeing used, The is also most times declared right below the control line. Most advanced Frame have such a thing or a custom named version of it.
11 |Used in: MENU, POPUPMENU, BUTTON, GLUEBUTTON, TEXTBUTTON, GLUETEXTBUTTON, SCROLLBAR, SLIDER, CONTROL, TEXTAREA, EDITBOX, GLUEEDITBOX, GLUECHECKBOX, CHECKBOX
12 | 13 | -------------------------------------------------------------------------------- /Keywords/StringList.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |StringList is an Fdf-Action that creates Localilzed Strings, which can be get during the game with GetLocalizedString and in fdf.
9 |The Text inside "" can not be escaped with \
10 |StringList {
11 | MYTEST "My Test",
12 | MYLABEL "My Label",
13 | MYVALUE "My Value",
14 | MYLongText "My Super Long
15 | MultiLine Text,
16 | is this",
17 | }
18 |
19 | Between the Name and the valueText can be any amount of Whitespace. The valueText can go over multiple Lines. Like shown in MYLongText
20 |The Key needs to follow jass variable name rules.
21 | 22 | 23 | -------------------------------------------------------------------------------- /Keywords/TexCoord.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: TexCoord Left, Right, Up, Bottom,
9 |Example: TexCoord 0, 1, 0, 0.125,
10 |Purpose: Uses only a fraction of the given Image. The given Numbers are factors from 0 to 1. left=0 and right=1 Up=0 and bottom=1; The subsection of the Image is stretched to the frames Size. It is suggested to open the used image with something like GIMP select the wanted space change to show percent.
11 |Purpose: One can produce a tiled image using numbers bigger than 1 for right and bottom.
12 |Example: TexCoord 0, 2, 0, 2,
13 |Used in: Texture(SIMPLEFRAME)
14 | 15 | 16 | -------------------------------------------------------------------------------- /Keywords/MenuItem.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: MenuItem Text, integer,
9 |Example: MenuItem "ON", -2,
10 |Purpose: Adds an Selectable option to a MENU / PopupMenuFrame. The number is always -2 in Blizzards fdfs. The List items are parsed from first line to lowest line.
11 |Integer: Where in the List is the item added. I suspect the menu to work based on a linked List.
-2 End of List
-1 Top Of List.
0+ place the item x after the top or something like that. You need at least one item that uses -1/-2, using 0+ can crash the game. I strongly suggest to use -1 & -2.
Used in: MENU
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/IncludeFile.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: IncludeFile FilePath,
9 |Example: IncludeFile "UI\FrameDef\Glue\StandardTemplates.fdf",
10 |Example: IncludeFile "UI\FrameDef\UI\EscMenuTemplates.fdf",
11 |Purpose: Allows to inherit Frames from included files. One can add multiple IncludeFile lines. The files mentioned in the IncludeFile list should be sorted by Alphabet (abc)
12 |Recursion: When the loaded targetFile uses IncludeFile, then your fdf loads it too. "Escmenuoptionspanel" Includes "EscMenuTemplates", therefore yours includes both when you include "Escmenuoptionspanel".
13 |Used in: Fdf
14 | 15 | 16 | -------------------------------------------------------------------------------- /Keywords/BackdropBackgroundInsets.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: BackdropBackgroundInsets real real real real,
9 |Example: BackdropBackgroundInsets 0.004 0.004 0.004 0.004,
10 |Purpose: Cuts in the mainTexture from the outside, to define space between the edgeFile (Border) and the mainTexture
11 |The args are Right, TOP, Bottom, Left.
12 |The values can be negative to increase the space on which the the Background is displayed, the position of the frame and Edge keep untouched.
13 |Can also be used to rotate the Backdrop when Top&Bottom are as big as the Height than the Icon will be rotated.
14 |Used in: BACKDROP
15 | 16 | 17 | -------------------------------------------------------------------------------- /Keywords/SetPoint.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: SetPoint FramePoint-Own, FrameName , FramePoint-FrameName, xOffset , yOffset,
9 |Example: SetPoint LEFT, "UpperButtonBarAlliesButton", RIGHT, 0, 0,
10 |Example: SetPoint TOPLEFT, "InfoPanelIconAllyWoodIcon", BOTTOMLEFT, 0.0, 0.0,
11 |Purpose: Pos the frame with its own FramePoint to FramePoint-FrameName with xOffset and yOffset (+x is right +y is up). When the Frame is created "call" BlzFrameSetPoint(self, FramePoint-Own, BlzGetFrameByName(FrameName, 0), FramePoint-FrameName, x, y).
With UseActiveContext, use CreationContext inside BlzGetFrameByName instead of 0.
The targeted Frame needs to be created before the current Frame. It can be a brother but then needs to be above (lineNr).
Used in: EveryWhere
13 | 14 | 15 | -------------------------------------------------------------------------------- /Keywords/FontFlags.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: FontFlags text,
9 |Example: FontFlags "PASSWORDFIELD",
10 |
Purpose: The text will be displayed only with *
Example: FontFlags "IGNORECOLORCODES",
12 |
Purpose: |cffff00a0 is not parsed and displayed on the screen text
Example: FontFlags "IGNORENEWLINES",
14 |
Purpose: |n & \n have no effect and are displayed on the screen
Example: FontFlags "NONPROPORTIONAL",
16 |
Purpose: monospaced font (same amount of horizontal space)
Example: FontFlags "NOWRAP",
18 |
Purpose: Displays only the text fitting into the first Line
Example: FontFlags "FIXEDSIZE",
20 |
Purpose:
Example: FontFlags "FIXEDCOLOR",
22 |
Purpose:
Example: FontFlags "HIGHLIGHTONMOUSEOVER",
24 |
Purpose:
Used in: TEXT
26 | 27 | 28 | -------------------------------------------------------------------------------- /Keywords/UseBackdrop.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Format: UseBackdrop "name",
9 |Purpose: SimpleFrame Backdrop with the Backdrop defined outside of the simpleframe
10 |Used in: SIMPLEBUTTON, SIMPLECHECKBOX, SIMPLEFRAME, SIMPLESTATUSBAR
11 |
12 | Backdrop "TestBackdrop" {
13 | BackdropTileBackground,
14 | BackdropBackground "EscMenuEditBoxBackground",
15 | BackdropCornerFlags "UL|UR|BL|BR|T|L|B|R",
16 | BackdropCornerSize 0.0125,
17 | BackdropBackgroundSize 0.256,
18 | BackdropBackgroundInsets 0.005 0.005 0.005 0.005,
19 | BackdropEdgeFile "EscMenuEditBoxBorder",
20 | }
21 |
22 | Frame "SIMPLEFRAME" "SimpleBackdrop" {
23 | DecorateFileNames,
24 | Width 0.1,
25 | Height 0.1,
26 | SetPoint CENTER, "ConsoleUI", CENTER,0.0,0.1,
27 | UseBackdrop "TestBackdrop",
28 | }
29 |
30 |
31 |
--------------------------------------------------------------------------------
/Keywords/Frame.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Format1: Frame "FRAMETYPE" "FrameName" {}
9 |Format2: Frame "FRAMETYPE" "FrameName" INHERITS "FrameNameInherited" {}
10 |Format3: Frame "FRAMETYPE" "FrameName" INHERITS WITHCHILDREN "FrameNameInherited" {}
11 |Purpose: Define a new Frame of "FRAMETYPE" with "FrameName". In Format2 fdf Actions from the inherited Frame are cloned. WithChildren will also clone fdfActions for child-Frames. The FrameName can be empty "", but it has to be there. The fdf-Actions inside {} belong to the Frame. I call a Frame defined outside of other Frames MainFrame it can be created and inherited. Frames defined inside Frames are child-Frames. 12 |
Example: Frame "FRAME" "TimerDialog"
13 |Example: Frame "BACKDROP" "QuestButtonBackdropTemplate" INHERITS "QuestButtonBaseTemplate"
14 |Example: Frame "GLUETEXTBUTTON" "ScriptDialogButton" INHERITS WITHCHILDREN "EscMenuButtonTemplate"
15 | 16 | -------------------------------------------------------------------------------- /FrameTypes/HIGHLIGHT.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Displays Textures (dds, blp, tga, tif) for the Frame Family. They have various ways to interpret/use the given textures alpha.
9 |In Warcraft 3 V1.31 and V1.32 there is no way to alter the used Texture during the game. Changing the Parent of a Highlight during the game can bug it, making it overglow sometimes.
10 | 11 |SPRITE is a non-Interactive Frame displaying a Warcraft 3 model and loops it's animation. Changing the Parent of a Sprite during the game can bug, speeding up the displayed animation. Game Pause does not stop the animation
9 | 10 |11 | BlzFrameSetSpriteAnimate 12 | birth = 0 13 | death = 1 14 | stand = 2 15 | morph = 3 16 | alternate = 4 17 |18 | 19 |
Format: SimpleButtonChild NAMED name, Texture,
9 |Example: NormalTexture NAMED "MyIconA", "MyUpperMenuButtonBackground",
10 |Example: PushedTexture NAMED "MyIconB", "MyUpperMenuButtonPushedBackground",
11 |Purpose: give a name to functional texture/string children of a SIMPLEBUTTON. Then they can be accessed in map script with BlzGetFrameByName
12 |Used in: SIMPLEBUTTON
13 |
14 | Texture "MyUpperMenuButtonHighlight" {
15 | File "UpperMenuButtonTexture",
16 | TexCoord 0.0, 0.6640625, 0.75, 0.921875,
17 | AlphaMode "ADD",
18 | }
19 | Texture "TextureTemplate" {}
20 | Frame "SIMPLEBUTTON" "TestA" {
21 | DecorateFileNames,
22 | Width 0.085,
23 | Height 0.022,
24 | NormalTexture NAMED "MyIconA2","TextureTemplate",
25 | PushedTexture NAMED "MyIconB2","TextureTemplate",
26 | DisabledTexture NAMED "MyIconC2","TextureTemplate",
27 | UseHighlight "MyUpperMenuButtonHighlight",
28 | }
29 |
30 |
--------------------------------------------------------------------------------
/FrameTypes/MODEL.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Unanimated model of the Frame Family.
9 | 10 | 11 |Interactive of the SimpleFrame Family. Unlike BUTTON it does not keep the focus.
9 |Only the last added event (for each SIMPLEBUTTON) triggers
10 | 11 |
26 | Frame "SIMPLEBUTTON" "MySimpleButton" {
27 | Width 0.039,
28 | Height 0.039,
29 | Texture "MySimpleButtonTexture" {
30 | }
31 | }
32 |
33 |
34 |
--------------------------------------------------------------------------------
/FrameTypes/STATUSBAR.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | STATUSBAR is a non-Interactive frame displaying a warcraft 3 model. Unlike Sprite it does not loop the animation but the current animationTime can be set using BlzFrameSetValue as % of Min/Max to AnimationTime. It is said "STATUSBAR" only supports 1s animations, sequzenzes after 1s are droped. This type is quite good createable with code only
9 | 10 |11 | BlzFrameSetSpriteAnimate 12 | birth = 0 13 | death = 1 14 | stand = 2 15 | morph = 3 16 | alternate = 4 17 |18 | 19 |
A combo of a TextInput and a TextArea. But it does nothing automatic. There is an example in Battlenettemplates.fdf
9 | 10 |Format: ControlStyle "Text|Text",
10 |Example: ControlStyle "AUTOTRACK|HIGHLIGHTONFOCUS|HIGHLIGHTONMOUSEOVER",
11 |Example: ControlStyle "AUTOTRACK",
12 |Example: ControlStyle "AUTOTRACK|HIGHLIGHTONMOUSEOVER",
13 |AUTOTRACK: Mouse Clicks onto the button won't affect the world below the button. An Unit can not be ordered at a target below it nor units can be selected below the button.
14 |HIGHLIGHTONMOUSEOVER: Enables the usage of ControlMouseOverHighlight.
15 |HIGHLIGHTONFOCUS: Enables the usage of ControlFocusHighlight.
16 |CLICKONMOUSEDOWN: FRAMEEVENT_CONTROL_CLICK & Audio click sound happen on click instead of release
17 |ATLEASTONE:
18 |EXCLUSIVE: Used in RADIOGROUP: only one checkbox can be checked at a time (each user can check a different one).
19 |SHIFTDESELECT:
20 |DRAG:
21 |RELEASENOTIFY:
22 |AUTODOWN:
23 |MULTISELECT:
24 | 25 |Used in: BUTTON, GLUEBUTTON, TEXTBUTTON, GLUETEXTBUTTON, GLUECHECKBOX
26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /Common/HirachyGameUIOverview.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |GameUI is the ancestor of non SimpleFrames. This is the overview Page. It only shows the direct children.
9 |ORIGIN_FRAME_GAME_UI has on default 14 children. Multiboard, Leaderboard, TimerDialog, and QuestDialog are added when needed. With them it has 19.
10 | After anyone clicked the QuestDialog 2 further ones are added.
11 | Custom added Frames takes slots from [8] pushing others back after Chat/Log when created with prio(0)
[0] ORIGIN_FRAME_WORLD_FRAME 14 | [1] Probably Parent of World Object Hover info box & HP/Mana Bars 15 | [2] BottomUI Black Background "ConsoleUIBackdrop" 16 | [3] Parent of ORIGIN_FRAME_PORTRAIT 17 | [4] InventoryText, Related to the visuals of SimpleFrames, hiding it makes all SimpleFrames not visible but still clickable 18 | [5] Day Time Clock & Minimap are affected by this one, maybe ancestor/Parent 19 | [6] "CinematicPanel" 20 | [7] "ChatDialog"/"LogDialog" 21 | [8] "Multiboard" 22 | [9] "Leaderboard" 23 | [10] "TimerDialog" 24 | [11] No Idea 25 | [12] "QuestDialog" 26 | [13] "AllianceDialog" 27 | [14] No Idea 28 | [15] Parent Of "EscMenuBackdrop" 29 | [16] Chat Input 30 | [17] EscOptions 31 | [18] Mouse Cursor (Parent) 32 |33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /Keywords/ToolTip.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
Format: ToolTip FrameName,
9 |Example: ToolTip "CodeTextFrame",
10 |Purpose: After this Frame was created (Includes all children), the game "calls" BlzFrameSetTooltip(this, BlzGetFrameByName(frameName, createdContext)). When the ToolTipFrame is created in another Frame then the ToolTipFrame needs to be written at an earlier line.
11 |Used in: none SimpleFrames
12 |
13 | IncludeFile "UI\FRAMEDEF\UI\ESCMENUTEMPLATES.FDF",
14 | Frame "FRAME" "TestFrame" {
15 | Frame "TEXT" "ToolTipFrame" {
16 | Text "Test Tooltip Text",
17 | SetPoint TOPRIGHT, "ConsoleUI", TOPRIGHT, -0.2, -0.2,
18 | }
19 | Frame "GLUETEXTBUTTON" "ButtonFrame" INHERITS WITHCHILDREN "EscMenuButtonTemplate" {
20 | Width 0.13,
21 | Height 0.03,
22 | UseActiveContext,
23 | SetPoint CENTER, "ConsoleUI", CENTER, 0, 0,
24 | ToolTip "ToolTipFrame",
25 | }
26 | }
27 |
28 | Frame "GLUETEXTBUTTON" "TestButtonFrame" INHERITS WITHCHILDREN "EscMenuButtonTemplate" {
29 | Width 0.13,
30 | Height 0.03,
31 | SetPoint CENTER, "ConsoleUI", CENTER, 0, 0,
32 | ToolTip "ToolTipFrame",
33 | Frame "TEXT" "ToolTipFrame" {
34 | Text "Test Tooltip Text",
35 | SetPoint BOTTOM, "TestButtonFrame", TOP, 0, 0,
36 | }
37 | }
38 |
39 |
40 |
41 |
--------------------------------------------------------------------------------
/FrameTypes/BUTTON.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Basic interactive of the Frame Family.
9 | 10 |Format: HighlightAlphaFile FilePath,
9 |Example: HighlightAlphaFile "UI\Glues\ScoreScreen\scorescreen-tab-hilight.blp",
10 |Purpose: Set the file beeing used by that Highlight
25 |Used in: HIGHLIGHT
26 | 27 | 28 | -------------------------------------------------------------------------------- /FrameTypes/MENU.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Container of the choices of a POPUPMENU.
9 | 10 |
29 | IncludeFile "UI/FrameDef/UI/EscMenuTemplates.fdf",
30 | Frame "MENU" "TestPopupMenu" INHERITS WITHCHILDREN "EscMenuPopupMenuMenuTemplate" {
31 | // the selectable options
32 | // they will try to load a Localized String
33 | MenuItem "TestA", -2,
34 | MenuItem "TestB", -2,
35 | MenuItem "TestC", -2,
36 | MenuItem "TestD", -2,
37 | }
38 |
39 |
40 |
--------------------------------------------------------------------------------
/FrameTypes/CHECKBOX.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | On/Off toggle of the Frame Family.
9 | 10 |Basic text display of the Frame Family. Can be a oneLine or multiline text.
9 |To have an auto expanding multiline text set Width x and Height 0.
10 | 11 |ConsoleUI is the ancestor of SimpleFrames.
9 |10 | [0] "ConsoleTopBar", 0 11 | [1] "ConsoleBottomBar", 0 12 | [0] "ConsoleBottomBarOverlay", 0 13 | [1] "CommandBarFrame", 0 14 | [0 to 11] "CommandButton_0",0 to "CommandButton_11",0 15 | [0] ORIGIN_FRAME_COMMAND_BUTTON 16 | Created when required 17 | [0] Cooldown 18 | [1] 19 | [2] ChargeBox 20 | [2] "SimpleInfoPanelUnitDetail", 0 Parent ? 21 | [3] IdleWorkerFace 22 | [0] Button 23 | [0] Charges Box (created with the first idle worker) 24 | [4] ORIGIN_FRAME_UBERTOOLTIP ? 25 | [2] "ResourceBarFrame",0 26 | [0] Mouse Listener (Gold) 27 | [1] Mouse Listener (Lumber) 28 | [2] Mouse Listener (UpKeep) 29 | [3] Mouse Listener (Food) 30 | [???] Fps/Apm/Ping display 31 | [x] "ResourceBarGoldText",0 32 | [x] "ResourceBarLumberText",0 33 | [x] "ResourceBarSupplyText",0 34 | [x] "ResourceBarUpkeepText",0 35 | [3] "UpperButtonBarFrame",0 36 | [0] Quest/"UpperButtonBarQuestsButton",0 37 | [1] Menu/"UpperButtonBarMenuButton",0 38 | [2] Alliance/"UpperButtonBarAlliesButton",0 39 | [3] Log/"UpperButtonBarChatButton",0 40 | [4] "MiniMapButtonBar",0 41 | [0 to 4] Buttons 0(Top), 4(Bottom) 42 | [5] command button mouse deadzone 43 | [6] Hero ButtonBar 44 | [0 to 6] HeroButtons 45 | [0] HP-Bar 46 | [1] MP-Bar 47 | [2] Unspent-SkillPointsBox (only when this slot ever had unspent SkillPoints) 48 | [7] World Object Hover info (exist after any object was hovered with the mouse) 49 |50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /FrameTypes/EDITBOX.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
Textinput of the Frame Family.
9 | 10 |Format: ControlShortcutKey Text,
9 |Example: ControlShortcutKey "KEY_CANCEL_SHORTCUT",
10 |Purpose: This Frame will read a StringList value and use it for it's hotkey. Only got it working when the Parent had TabFocusPush.
Only uses the First Char of the loaded StringList entry "27" becomes just hotkey 2.
Used in: BUTTON, GLUEBUTTON, TEXTBUTTON, GLUETEXTBUTTON
12 | 13 | ---------------
16 | IncludeFile "UI\FrameDef\UI\EscMenuTemplates.fdf",
17 |
18 | // The Hotkeys for the Buttons
19 | StringList {
20 | KeyMyButton1 "1",
21 | KeyMyButton2 "2",
22 | KeyMyButton3 "3",
23 | }
24 |
25 | Frame "FRAME" "MyButtonF" {
26 | Width 0.1,
27 | Height 0.1,
28 | TabFocusPush, // Enables ControlShortcutKey for children
29 | LayerStyle "IGNORETRACKEVENTS", // this Frame itself will not control/Block the Mouse
30 | Frame "GLUEBUTTON" "MyButton1" INHERITS WITHCHILDREN "EscMenuButtonTemplate" {
31 | ControlShortcutKey "KeyMyButton1",
32 | SetPoint TOP, "MyButtonF", TOP, 0, 0,
33 | }
34 | Frame "GLUEBUTTON" "MyButton2" INHERITS WITHCHILDREN "EscMenuButtonTemplate" {
35 | ControlShortcutKey "KeyMyButton2",
36 | SetPoint TOP, "MyButton1", BOTTOM, 0, 0,
37 | }
38 | Frame "GLUEBUTTON" "MyButton3" INHERITS WITHCHILDREN "EscMenuButtonTemplate" {
39 | ControlShortcutKey "KeyMyButton3",
40 | SetPoint TOP, "MyButton2", BOTTOM, 0, 0,
41 | }
42 | }
43 |
44 |
45 |
46 |
--------------------------------------------------------------------------------
/Common/HirachyConsoleUI.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | ConsoleUI is the ancestor of SimpleFrames.
9 |10 | [0] "CommandBarFrame",0 11 | Before an unit was selected "CommandBarFrame" has 24 childs "CommandButton_0" to "CommandButton_11" and (ORIGIN_FRAME_COMMAND_BUTTON,0 to 11) 12 | After an unit was selected ORIGIN_FRAME_COMMAND_BUTTONs become children of "CommandButton_0" to "CommandButton_11" 13 | [0 to 11] "CommandButton_0",0 to "CommandButton_11",0 14 | [0] ORIGIN_FRAME_COMMAND_BUTTON 15 | Created when required 16 | [0] Cooldown 17 | [1] 18 | [2] ChargeBox 19 | [1] BottomCenter UI parent (unit info- Inventory) 20 | [2] "ResourceBarFrame",0 21 | [0] Mouse Listener (Gold) 22 | [1] Mouse Listener (Lumber) 23 | [2] Mouse Listener (UpKeep) 24 | [3] Mouse Listener (Food) 25 | [???] Fps/Apm/Ping display 26 | [x] "ResourceBarGoldText",0 27 | [x] "ResourceBarLumberText",0 28 | [x] "ResourceBarSupplyText",0 29 | [x] "ResourceBarUpkeepText",0 30 | [3] "UpperButtonBarFrame",0 31 | [0] Quest/"UpperButtonBarQuestsButton",0 32 | [1] Menu/"UpperButtonBarMenuButton",0 33 | [2] Alliance/"UpperButtonBarAlliesButton",0 34 | [3] Log/"UpperButtonBarChatButton",0 35 | [4] "MiniMapButtonBar",0 36 | [0 to 4] Buttons 0(Top), 4(Bottom) 37 | [5] command button mouse deadzone 38 | [6] Hero ButtonBar 39 | [0 to 6] HeroButtons 40 | [0] HP-Bar 41 | [1] MP-Bar 42 | [2] Unspent-SkillPointsBox (only when this slot ever had unspent SkillPoints) 43 | [7] Idle worker Button Container 44 | [0] Button 45 | [0] Charges Box (created with the first idle worker) 46 | [8] World Object Hover info (exist after any object was hovered with the mouse) 47 |48 | 49 | 50 | 51 | -------------------------------------------------------------------------------- /FrameTypes/RADIOGROUP.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
RadioGroup binds checkboxes into a group together with ControlStyle "EXCLUSIVE", one can make sure only one of them is selected. Each player can have a different selected.
9 | 10 |
19 | IncludeFile "UI\FrameDef\UI\EscMenuTemplates.fdf",
20 | Frame "RADIOGROUP" "RadioGroup" {
21 | ControlStyle "EXCLUSIVE",
22 |
23 | Frame "GLUECHECKBOX" "CheckBoxA" INHERITS WITHCHILDREN "EscMenuCheckBoxTemplate" {
24 | Width 0.012,
25 | Height 0.012,
26 | SetPoint CENTER, "ConsoleUI", CENTER, 0, 0,
27 | }
28 | Frame "GLUECHECKBOX" "CheckBoxB" INHERITS WITHCHILDREN "EscMenuCheckBoxTemplate" {
29 | Width 0.012,
30 | Height 0.012,
31 | SetPoint CENTER, "ConsoleUI", CENTER, 0.1, 0,
32 | }
33 | Frame "GLUECHECKBOX" "CheckBoxC" INHERITS WITHCHILDREN "EscMenuCheckBoxTemplate" {
34 | Width 0.012,
35 | Height 0.012,
36 | SetPoint CENTER, "ConsoleUI", CENTER, 0.15, 0,
37 | }
38 | Frame "GLUECHECKBOX" "CheckBoxD" INHERITS WITHCHILDREN "EscMenuCheckBoxTemplate" {
39 | Width 0.012,
40 | Height 0.012,
41 | SetPoint CENTER, "ConsoleUI", CENTER, 0.2, 0,
42 | }
43 |
44 | RadioItem "CheckBoxA",
45 | RadioItem "CheckBoxB",
46 | RadioItem "CheckBoxC",
47 | RadioItem "CheckBoxD",
48 | }
49 |
50 |
51 |
--------------------------------------------------------------------------------
/Common/FrameLevel.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | When multiple Frames are at the same space, there is an rule that tells who will take the mouse Events and is displayed on top. FrameLevel set with BlzFrameSetLevel manages that, it only matters when Frames colide/overlap on the screen. Only visible Frames matter for the FrameLevel order. 9 | FrameLevel works different for SimpleFrames and Frames.
10 | 11 |
14 |
15 |
Slider is an interactive frames to set a value inside the bounds of a min and max. Min and max are valid values. The user is able to set the value by draging the button of the Slider or clicking inside the Slider. Warcraft 3 has Vertical or Horizontal Sliders.
9 |Mostly used as free. For a functional child SCROLLBAR.
10 | 11 |34 | -- create a vertical slider by inheriting from a Scrollbar. It will use esc menu textures 35 | local sliderFrame = BlzCreateFrameByType( "SLIDER", "TestSlider", BlzGetOriginFrame(ORIGIN_FRAME_GAME_UI,0), "QuestMainListScrollBar", 0 ) 36 |37 | 38 | -------------------------------------------------------------------------------- /FrameTypes/BACKDROP.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
BACKDROP display Textures (dds, blp, tga, tif) for the Frame Family. They are borders, backgrounds or images (for non simple frames). Most frames beeing more than simple text have backdrops that manage the textures beeing shown.
9 |When you set the texture with the map script the border setup is droped.
10 |Scrollable multiline text display of the Frame Family.
9 | 10 |
30 | IncludeFile "UI\FrameDef\UI\EscMenuTemplates.fdf", //Frames from that fdf can be inherited in this file
31 | IncludeFile "UI\FrameDef\UI\QuestDialog.fdf",
32 |
33 | Frame "TEXTAREA" "MyTextArea" {
34 | DecorateFileNames,
35 | FrameFont "InfoPanelTextFont", 0.020, "",
36 |
37 | TextAreaLineHeight 0.018, //Should fit used font Size, a high difference shows no text or much space between lines.
38 |
39 | TextAreaLineGap 0.00, //adds that much space between 2 Lines, addtional to TextAreaLineHeight.
40 |
41 | TextAreaInset 0.035, //Moves the Text and the scrollbar into the middle from all sides by this amount. This increases the min size for game crash.
42 |
43 | TextAreaMaxLines 20, //Only that amount of lines are displayed, if more lines are added oldest are removed.
44 |
45 | TextAreaScrollBar "MyTextAreaScrollBar",
46 | Frame "SCROLLBAR" "MyTextAreaScrollBar" INHERITS WITHCHILDREN "EscMenuScrollBarTemplate" {
47 | }
48 |
49 | ControlBackdrop "MyTextAreaBackdrop",
50 | Frame "BACKDROP" "MyTextAreaBackdrop" INHERITS "QuestButtonBaseTemplate" {
51 | }
52 | }
53 |
54 |
55 |
--------------------------------------------------------------------------------
/Keywords/Backdrop.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Format: Backdrop "name" INHERITS "name2" {}
9 |Format: Backdrop {}
10 |Purpose: Define a Backdrop used by SimpleFrames with UseBackdrop or placed directly inside a SimpleFrame.
The Backdrop can not be accessed by BlzGetFrameByName and copies the Frames position & Size. It can do most what Frame "BACKDROP" can do. Layer does not work on it and the border is higher then the background but the Backdrop is inside the SimpleFrames Layer. Textures & Strings inside Layer "BACKGROUND" often are lower than the Backdrop. Will show no background when BackdropBackground is empty or invalid. But a Border File must be correct when it is requested with BackdropEdgeFile. Always uses BackdropBlendAll. Like Texture uses DecorateFileNames from the parent simpleframe.
Used in: SIMPLEBUTTON, SIMPLECHECKBOX, SIMPLEFRAME, SIMPLESTATUSBAR
12 |
13 | Frame "SIMPLESTATUSBAR" "SimpleBackdrop2" {
14 | DecorateFileNames,
15 | Width 0.1,
16 | Height 0.1,
17 | SetPoint CENTER, "ConsoleUI", CENTER,0.0,0.1,
18 | Backdrop {
19 | BackdropTileBackground,
20 | BackdropBackground "EscMenuEditBoxBackground",
21 | BackdropCornerFlags "UL|UR|BL|BR|T|L|B|R",
22 | BackdropCornerSize 0.0125,
23 | BackdropBackgroundSize 0.1,
24 | BackdropBackgroundInsets 0.005 0.005 0.005 0.005,
25 | BackdropEdgeFile "EscMenuEditBoxBorder",
26 | // BackdropBlendAll,
27 | }
28 | }
29 |
30 | Frame "SIMPLEFRAME" "SimpleBackdrop3" {
31 | Width 0.1,
32 | Height 0.1,
33 | SetPoint CENTER, "ConsoleUI", CENTER,0.0,0.1,
34 | Backdrop {
35 | BackdropBackground "ReplaceableTextures/CommandButtons/BTNPriest",
36 | BackdropMirrored,
37 | }
38 | Layer "ARTWORK" {
39 | Texture {
40 | Width 0.05,
41 | Height 0.05,
42 | File "ReplaceableTextures/CommandButtons/BTNPriest",
43 | Anchor CENTER,0,0,
44 | }
45 | }
46 | Layer "BACKGROUND" {
47 | Texture {
48 | Width 0.05,
49 | Height 0.05,
50 | File "ReplaceableTextures/CommandButtons/BTNHeroPaladin",
51 | Anchor CENTER,0,0.05,
52 | }
53 | }
54 | }
55 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/FrameTypes/DIALOG.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | More advanced ContainterFrame of the Frame Family.
9 |Dialog is a Frame to give the player the option to accept or decline. But the dialogevents are only useable when the dialog's buttons were defined in fdf.
10 | 11 |
26 | IncludeFile "UI\FrameDef\UI\EscMenuTemplates.fdf",
27 | IncludeFile "UI\FrameDef\Glue\StandardTemplates.fdf",
28 | Frame "DIALOG" "MySimplyDialog" {
29 | Height 0.06,
30 | Width 0.09,
31 | SetPoint CENTER, "ConsoleUI", CENTER, 0, 0,
32 |
33 | DialogBackdrop "MySimplyDialogBackdrop",
34 | Frame "BACKDROP" "MySimplyDialogBackdrop" {
35 | UseActiveContext,
36 | SetAllPoints,
37 | DecorateFileNames,
38 | BackdropTileBackground,
39 | BackdropBackground "EscMenuEditBoxBackground",
40 | BackdropCornerFlags "UL|UR|BL|BR|T|L|B|R",
41 | BackdropCornerSize 0.0125,
42 | BackdropBackgroundInsets 0.005f 0.005f 0.005f 0.005f,
43 | BackdropEdgeFile "EscMenuEditBoxBorder",
44 | BackdropBlendAll,
45 | }
46 |
47 | Frame "TEXT" "MySimplyDialogTitleText" INHERITS "StandardTitleTextTemplate" {
48 | SetPoint TOP, "MySimplyDialog", TOP, 0.0, -0.005,
49 | Text "Kick Red",
50 | }
51 |
52 | DialogOkButton "MySimplyDialogOKButton",
53 | Frame "GLUETEXTBUTTON" "MySimplyDialogOKButton" INHERITS WITHCHILDREN "EscMenuButtonTemplate" {
54 | Width 0.04,
55 | Height 0.03,
56 | SetPoint BOTTOMRIGHT,"MySimplyDialog", BOTTOM, 0, 0.005625,
57 | ControlShortcutKey "KEY_OK_SHORTCUT",
58 | ButtonText "ConfirmOKButtonText",
59 | Frame "TEXT" "ConfirmOKButtonText" INHERITS "StandardButtonTextTemplate" {
60 | Text "YES",
61 | }
62 | }
63 |
64 | DialogCancelButton "MySimplyDialogCancelButton",
65 | Frame "GLUETEXTBUTTON" "MySimplyDialogCancelButton" INHERITS WITHCHILDREN "StandardButtonTemplate" {
66 | Width 0.04,
67 | Height 0.03,
68 | SetPoint BOTTOMLEFT,"MySimplyDialog", BOTTOM, 0, 0.005625,
69 | ControlShortcutKey "KEY_CANCEL_SHORTCUT",
70 | ButtonText "ConfirmCancelButtonText",
71 | Frame "TEXT" "ConfirmCancelButtonText" INHERITS "StandardButtonTextTemplate" {
72 | Text "NO",
73 | }
74 | }
75 | }
76 |
77 |
78 |
79 |
--------------------------------------------------------------------------------
/Common/Syntax.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | A Frame Definition File is a fileType used in warcraft 3 to define an UI-Frame. Fdf has a second use case, they can define StringLists with such a StringList one can set Localized Strings.
Inside fdf one can write Text which is ignored by the fdf parser. There are Line comments and area commentents.
9 |
// I am a Line comment 10 | 11 | /* Opens the Area Comment 12 | * 13 | * 14 | */ End the Area Comment15 |
Fdf describes Frames and StringLists. The content of a fdf can be seen as a collection of fdfActions.
16 |There exists something like 105 fdf-actions. Each of this actions is followed by a group of arguments which are either seperated by whitespace or by comma + optional whitespace. Between the first argument and the Action is whitespace. The used rule of seperation depends on the Action. Some FDF-Actions have multiple Versions with different amount of arguments.
17 |An example for each:
18 |Actions not opening a Block { } end with a comma. Only the Actions: Frame, String, Texture, Layer and StringList open Blocks. All of them except for Layer can exist outside of Blocks. IncludeFile and StringList are Actions only written outside of Blocks. Other fdf-Actions have to be in a Block. Actions in a Block belong to the Action that started the Block most times defining a Frame. One Line can contain multiple Actions in a row without any Line seperator.
24 |I personaly call Frames defined outside of Blocks MainFrame, when I talk about them. Only such MainFrames can be Created & Inherited. Frames can have any amount of Child-Frames which also can have Child-Frames, but each Frame has only one Parent.
26 |For the Fdf-Action Frame: The names of MainFrames in one fdf have to be unique. If another MainFrame with the same name in the current fdf is encountered the remaining File-content is skiped. ChildFrames can have the same name as their brothers, their parent or be empty "".
27 |Fdf Frames support a behaviour called INHERITS in which a Frame copys the Fdf Actions from another Frame. There also exists an advanced version INHERITS WITHCHILDREN, this also copies the Child-Frames and uses their fdf-Actions. In fdf the Frame one wants to inherit from has to be from the same fdf or from an included one.
28 |Each Frame uses one of the Warcraft 3 FrameTypes, with the FrameType the behaviour and the set of possible fdf-Actions for that Frame is choosen. This FrameTypes can be placed into 2 groups SimpleFrames (all of them start with SIMPLE) and the others which I just call Frames (a bit confusing, cause all are Frames). One should do this seperation cause they have different features, techniques, rules and it is difficult to fit them together (logical not visual).
30 | 31 |In fdf paths are written only with one "\".
32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /FrameTypes/POPUPMENU.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Advanced Frame that shows a Set of choices below itself, when clicked. The choices are set with MENU.
9 |In V1.31 the choices do not render outside of 4:3.
10 |
32 | IncludeFile "UI/FrameDef/UI/EscMenuTemplates.fdf",
33 |
34 | Frame "POPUPMENU" "MyPopupTemplate" {
35 | Width 0.19625,
36 | Height 0.03,
37 | PopupButtonInset 0.01, // -x offset for PopupArrowFrame from RIGHT of the POPUPMENU
38 |
39 | // Background Enabled
40 | ControlBackdrop "MyPopupTemplateBackdropTemplate",
41 | Frame "BACKDROP" "MyPopupTemplateBackdropTemplate" INHERITS "EscMenuButtonBackdropTemplate" {
42 | }
43 |
44 | // Background Disabled
45 | ControlDisabledBackdrop "MyPopupTemplateDisabledBackdropTemplate",
46 | Frame "BACKDROP" "MyPopupTemplateDisabledBackdropTemplate" INHERITS "EscMenuButtonDisabledBackdropTemplate" {
47 | }
48 |
49 | // Text markup for the current selected Text, also can be used with a FrameEvent to know when someone starts selecting.
50 | PopupTitleFrame "PopupMenuTitleTemplate",
51 | Frame "GLUETEXTBUTTON" "PopupMenuTitleTemplate" INHERITS WITHCHILDREN "EscMenuPopupMenuTitleTemplate" {
52 | }
53 |
54 | // the Arrow at the right
55 | PopupArrowFrame "PopupMenuArrowTemplate",
56 | Frame "BUTTON" "PopupMenuArrowTemplate" INHERITS WITHCHILDREN "EscMenuPopupMenuArrowTemplate" {
57 | }
58 |
59 | // The Container for the selectable options
60 | // actulay it is smarter to not define this in the Template.
61 | //PopupMenuFrame "TestPopupMenu",
62 | //Frame "MENU" "TestPopupMenu" INHERITS WITHCHILDREN "EscMenuPopupMenuMenuTemplate" {
63 | //
64 | // }
65 | }
66 |
67 | Frame "POPUPMENU" "TestPopup" INHERITS WITHCHILDREN "MyPopupTemplate" {
68 | // The Container for the selectable options
69 | PopupMenuFrame "TestPopupMenu",
70 | Frame "MENU" "TestPopupMenu" INHERITS WITHCHILDREN "EscMenuPopupMenuMenuTemplate" {
71 | // the selectable options
72 | // they will try to load a Localized String
73 | MenuItem "TestA", -2,
74 | MenuItem "TestB", -2,
75 | MenuItem "TestC", -2,
76 | MenuItem "TestD", -2,
77 | }
78 | }
79 |
80 |
81 |
--------------------------------------------------------------------------------
/Common/ParentShip.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Frame - Parent is a powerful and useful concept of warcraft 3's UI-Frame System. Every frame has a parent frame. Any frame can have any amount of child frames. In the same time any child frame also can have any amount of child frames. When creating a new frame one also has to choose the Parent, as all create frame natives require an owner/parent.
9 |The 2 Frame groups can not be parent/child of each other while the game supports you to some degree to spawn a Frame anyway the wanted parent isn't the parent anymore in such a case.
10 |In many examples custom Frames are created as child of GAME_UI which is done to simple down the example. But it is ineffective to create all custom Frames for GAME_UI, if one has Frames that are logical connected it would make more sense to collecte them as childs of one Frame.
11 |FrameA child of Game_UI 12 | FrameB child of FrameA 13 | FrameC child of FrameA 14 | FrameD child of FrameA15 |
FrameA is the parent a logical container of FrameB, FrameC and FrameD.
16 |A child frame can only be visible when it's parent frame is visible. BlzFrameIsVisible also checks for the visibility of the parent frame. New created frames copy scale and alpha from their parent on default. This values can differ for the children when they are set (for the child frame) after the child frame was added to /created for the parent frame.
18 | 19 |BlzFrameSetScale 20 | BlzFrameSetAlpha 21 | When changing Parents the alpha value of the new Parent is copied. 22 | BlzFrameSetLevel 23 | Frames created for a parent frame also have the same Level.24 | A child tends to be visible above and is prefered by mouse events over its parent. SimpleFrames can break this rule when one changes Levels. 25 | 26 |
Functional child frames can only be defined and created inside fdf such children have a strong connection to their parent and perform some functionality for the parentFrame hence the name. An example of such functional child frame is ButtonText "ScriptDialogButtonText",This childFrame styles the text for it's parent frame "ScriptDialogButton". Functional childFrames copy even more from the ParentFrame, their position is automatically handled and they copy the enable state.
30 |All ChildFrames not being functional child-Frames are Loose child-Frames. They can be added in fdf and code. They do not perform any direct functionality for their parent. This code creates a new loose child frame for parentFrame. BlzCreateFrame("frameName", parentFrame, 0, 0) The position of a loose childFrame is on default independent from it's parent, it does not even require the parent frame to be placed on the screen.That behaviour can be used to create Frames with a higher FrameLevel then their type supports: Create A BUTTON set its FrameLevel and create the wanted Frames using him as parent for example TEXT-Frames.
31 |Want to show/hide a whole bunch of Frames collect them under one ParentFrame and change the ParentFrame's visibility. Now it only takes one line to toggle the visibility.
32 | 33 |The FrameParent concept simples down a lot of stuff you might want to accomplish. Want to create a new option in menu, create your Frame for ("EscMenuMainPanel", 0). Now the frame requires the visibility of ("EscMenuMainPanel", 0) and you can focus on the behaviour of the frame itself instead of handling the visiblity which can be quite complicated when injecting into the normal warcraft 3 UI. Only non SimpleFrames cause the wanted Parent is a Frame.
34 |Want to add a new UnitInfo (if you find a place for it on the screen) create it for ("SimpleInfoPanelUnitDetail", 0). But you need a SimpleFrame
35 | 36 | 37 | 38 | 39 | -------------------------------------------------------------------------------- /Common/HirachyBottomCenterUI.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |BottomCenterUI is a Child of ConsoleUI, but Quite big and important. The BottomCenterUI shows only one Panel at a Time. Based on the current need the panel is choosen, ("SimpleInventoryBar",0) & ("SimpleInventoryBar",0) are not part of the swaped panels.
9 |10 | [0] Single Unit "SimpleInfoPanelUnitDetail" 11 | [0] "SimpleHeroLevelBar",0 12 | [0] visual bar 13 | [1] The Exp-Tooltipbox 14 | [1] "SimpleProgressIndicator",0 15 | [0] visual Box 16 | [2] "SimpleBuildTimeIndicator",0 17 | [0] 18 | [3] "SimpleUnitStatsPanel",0 19 | [x] "SimpleClassValue",0 20 | [4] "SimpleInfoPanelIconDamage",0 21 | [0] Mouse Listener 22 | [x] "InfoPanelIconLabel",0 23 | [x] "InfoPanelIconLevel",0 24 | [x] "InfoPanelIconValue",0 25 | [x] "InfoPanelIconBackdrop",0 26 | ^^ InfoPanelIcon childs are used by SimpleInfoPanelIcon , 0 to 5 27 | [5] "SimpleInfoPanelIconDamage",1 28 | [0] Mouse Listener 29 | [6] "SimpleInfoPanelIconArmor",2 30 | [0] Mouse Listener 31 | [7] "SimpleInfoPanelIconRank",3 32 | [0] Mouse Listener 33 | [8] "SimpleInfoPanelIconFood",4 34 | [0] Mouse Listener 35 | [9 "SimpleInfoPanelIconGold",5 36 | [0] Mouse Listener 37 | [10] "SimpleInfoPanelIconHero",6 38 | [0] "SimpleInfoPanelIconHeroText",6 39 | [1] Mouse Listener 40 | [x] "InfoPanelIconHeroAgilityLabel", 6 41 | [x] "InfoPanelIconHeroAgilityValue", 6 42 | [x] "InfoPanelIconHeroIntellectLabel", 6 43 | [x] "InfoPanelIconHeroIntellectValue", 6 44 | [x] "InfoPanelIconHeroStrengthLabel", 6 45 | [x] "InfoPanelIconHeroStrengthValue", 6 46 | [x] "InfoPanelIconHeroIcon", 6 47 | [x] "SimpleInfoPanelIconHero", 6 48 | [x] "SimpleInfoPanelIconHeroText", 6 49 | [11] "SimpleInfoPanelIconAlly",7 50 | [0] Gold - Mouse Listener 51 | [1] Lumber - Mouse Listener 52 | [2] Food - Mouse Listener 53 | [3] UpKeep - Mouse Listener 54 | [x] "InfoPanelIconAllyFoodIcon", 7 55 | [x] "InfoPanelIconAllyFoodValue", 7 56 | [x] "InfoPanelIconAllyGoldIcon", 7 57 | [x] "InfoPanelIconAllyGoldValue", 7 58 | [x] "InfoPanelIconAllyTitle", 7 59 | [x] "InfoPanelIconAllyWoodIcon", 7 60 | [x] "InfoPanelIconAllyWoodValue", 7 61 | [12] ORIGIN_FRAME_UNIT_PANEL_BUFF_BAR 62 | [0 to 7] BuffIcons + mouse Listeners 63 | [x] ORIGIN_FRAME_UNIT_PANEL_BUFF_BAR_LABEL 64 | [13] 65 | [x] "SimpleNameValue", 0 66 | [x] "SimpleBuildingActionLabel", 0 67 | [1] Trainer "SimpleInfoPanelBuildingDetail",1 68 | [0] "SimpleBuildTimeIndicator",1 69 | [0] Bar Border 70 | [1] Que Button Backgrounds 71 | [2] Que Button next to the Progressbar 72 | [3] Que Bottom Button Container 73 | [0 to 5] Button 74 | [4] 75 | [x] "SimpleBuildingNameValue", 1 76 | [x] "SimpleBuildingDescriptionValue", 1 77 | [x] "SimpleBuildingActionLabel", 1 78 | [x] "SimpleBuildQueueBackdrop", 1 79 | [2] Transporter "SimpleInfoPanelCargoDetail",2 80 | [0] CargoContainer 81 | [0 to 9] Cargo Button Container (includes Box, pos themself the first time a Transporter with content is selected) 82 | [0] Button 83 | [1] Life Bar 84 | [2] Mana Bar 85 | [x] "SimpleHoldNameValue",2 86 | [x] "SimpleHoldDescriptionValue",2 87 | [3] Item on Ground "SimpleInfoPanelItemDetail",3 88 | [x] "SimpleItemNameValue", 3 89 | [x] "SimpleItemDescriptionValue", 3 90 | [4] selectable Gate/tree/etc "SimpleInfoPanelDestructableDetail",4 91 | [x] "SimpleDestructableNameValue", 4 92 | [5] multiple unit group selection 93 | [0] ContainerGroupButtons 94 | [0 to 11] ButtonContainer 95 | [0] Highlighter Background 96 | [1] Button 97 | [2] Life Bar 98 | [3] Mana Bar 99 | [6] "SimpleInventoryBar",0 100 | [0 to 5] "InventoryButton_0",0 to "InventoryButton_5",0 101 | [0] 102 | [7] "SimpleInventoryCover",0 (covers the inventory buttons when no inventory) 103 |104 | 105 | 106 | 107 | -------------------------------------------------------------------------------- /Common/Position.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
Positions on Screen are an important knowlage when using this whole UI-Frame feature. Warcraft 3 was at the beginning a 4:3 only Game. Hence their own UI-FrameWork has a coordinate system that makes sense for the 4:3 part.
9 |The Position goes from 0.0/0.0 at the Bottomleft (Minimap) to the Topright with 0.8/0.6 (Upkeep Level). The used Resolution does not matter, this values do not change. This Values are also used for Size of Frames. Pixel based size/Coords are only doable with some conversion math.
10 |11 | Coords are for the 4:3 Screen 12 | 13 | |0.0/0.6 0.8/0.6| 14 | | | 15 | | 0.4/0.3 | 16 | | | 17 | |0.0/0.0 0.8/0.0| 18 |> 19 |
One can imagine Frames as rectangles when one sets size and position. When only one FramePoint is placed the choosen FramePoint has a strong impact on the result. It limites the directions the Frame expands.
When using a point containing:
22 |
29 | Custom created Frames from the Frame group can not leave the 4:3 part of the screen. If a part of them leave it, they become malformed. A TEXT-Frame might cut off some chars. A BACKDROP becomes smaller and with that also Buttons and many others etc.
SimpleFrames are free from that limitation.
One can free Frames from that 4:3 limitation by creating them for a different Parent then GAME_UI, in Reforged such a Parent could be ("ConsoleUIBackdrop",0). Through that don't comes with a price. Using ("ConsoleUIBackdrop",0) as parent pushes them to a lower Layer, below SimpleFrames. 33 | One also could use BlzGetFrameByName("Leaderboard", 0) or BlzGetFrameByName("Multiboard", 0). This are above SimpleFrames but one has to create them first with the none Frame api. 34 | Your custom Frames can also be a child's child of that other Parents, the 4:3 Limitation is still gone.
35 | 36 |When one creates frames in fdf one can also set the position of frames. Here one has 2 to 3 options based on the current Frame: 37 |
This is an example fdf-Frame without UseActiveContext. It is not used because the frame shall attach itself to ("ConsoleUI", 0) even when created with a CreateContext that is not 0.
55 | That Frame of type BACKDROP with Name "Test" displays when created a Paladin-Icon at Top Left of the screen (The fdf containing that would have to be loaded over a toc first).
56 |
Frame "BACKDROP" "Test" {
57 | Width 0.1,
58 | Height 0.1,
59 | SetPoint TOPLEFT, "ConsoleUI", TOPLEFT, 0, 0,
60 | BackdropBackground "ReplaceableTextures\CommandButtons\BTNHeroPaladin",
61 | }
62 | interactive List of Textoptions (LISTBOXITEM) of the Frame Family.
9 |it seems that (In V1.32.6) the frame api lacks events to use LISTBOX intuitive making it kinda weak.
10 | 11 |
34 | IncludeFile "UI\FrameDef\Glue\StandardTemplates.fdf",
35 | IncludeFile "UI\FrameDef\UI\EscMenuTemplates.fdf",
36 |
37 | Frame "LISTBOXITEM" "MyListBoxItemTemplate" {
38 | }
39 | Frame "LISTBOX" "MyListBox" {
40 | Height 0.08,
41 | Width 0.12,
42 | SetPoint CENTER, "ConsoleUI", CENTER, 0, 0,
43 |
44 | ControlBackdrop "ListBoxBackdrop",
45 | Frame "BACKDROP" "ListBoxBackdrop" INHERITS "EscMenuEditBoxBackdropTemplate" {
46 | UseActiveContext,
47 | }
48 |
49 | ListBoxScrollBar "ListScrollBar",
50 | Frame "SCROLLBAR" "ListScrollBar" INHERITS WITHCHILDREN "StandardScrollBarTemplate" {
51 | }
52 |
53 | Frame "LISTBOXITEM" "A" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
54 | Text "Item A",
55 | }
56 | Frame "LISTBOXITEM" "B" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
57 | Text "Item B",
58 | }
59 | Frame "LISTBOXITEM" "C" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
60 | Text "Item C",
61 | }
62 | Frame "LISTBOXITEM" "D" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
63 | Text "Item D",
64 | }
65 | Frame "LISTBOXITEM" "E" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
66 | Text "Item E",
67 | }
68 | Frame "LISTBOXITEM" "F" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
69 | Text "Item F",
70 | }
71 | Frame "LISTBOXITEM" "G" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
72 | Text "Item G",
73 | }
74 | Frame "LISTBOXITEM" "H" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
75 | Text "Item H",
76 | }
77 | Frame "LISTBOXITEM" "I" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
78 | Text "Item I",
79 | }
80 | Frame "LISTBOXITEM" "J" INHERITS WITHCHILDREN "MyListBoxItemTemplate" {
81 | Text "Item J",
82 | }
83 |
84 |
85 | ListBoxBorder 0.01, // how big is the used border used for offsetting the items
86 |
87 | ListBoxItemHeight 0.013,
88 | ListBoxItem ADDEND, "A", // position at which FrameName is added, sadly the target loses its name
89 | ListBoxItem ADDEND, "B",
90 | ListBoxItem ADDEND, "C",
91 | ListBoxItem ADDEND, "D",
92 | ListBoxItem ADDEND, "E",
93 | ListBoxItem ADDEND, "F",
94 | ListBoxItem ADDEND, "G",
95 | ListBoxItem ADDEND, "H",
96 | ListBoxItem ADDEND, "I",
97 | ListBoxItem ADDEND, "J",
98 | }
99 |
100 |
--------------------------------------------------------------------------------
/Common/FrameTypes.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | This are the FrameTypes used in the fdfAction Frame, they uppercase only and a expected to be inside "".
9 |Frames can be seen as seperated into 2 Groups: Frames and SimpleFrames. While both can use most Frame-natives, they work quite different from each other and can not be parent/child for the other group.
10 |SimpleFrames are: SIMPLEBUTTON, SIMPLECHECKBOX, SIMPLEFRAME, SIMPLEGRID, SIMPLESTATUSBAR and the special Child-Frames String and Texture.
11 |GameUI is the ancestor of non SimpleFrames.
9 |10 | ORIGIN_FRAME_GAME_UI gets additinal children when the map has: Multiboard, Leaderboard or TimerDialog. Also when QuestDialog is opened. 11 | Custom added Frames takes slots from [8] pushing others back after Chat/Log when created with prio(0) 12 | 13 | [0] ORIGIN_FRAME_WORLD_FRAME 14 | [0] 15 | [1] Probably Parent of World Object Hover info box & HP/Mana Bars 16 | [2] BottomUI Black Background "ConsoleUIBackdrop" 17 | [3] Parent of ORIGIN_FRAME_PORTRAIT 18 | [0] ORIGIN_FRAME_PORTRAIT 19 | [1 to 7] ORIGIN_FRAME_HERO_BUTTON_INDICATOR 20 | [4] Parent of InventoryText, Related to the visuals of SimpleFrames, hiding it makes all SimpleFrames not visible but still clickable 21 | [0] "InventoryText" 22 | [5] Day Time Clock & Minimap are affected by this one, maybe ancestor/Parent 23 | [0] Affects the visual daytime clock (moving it has wierd effects) 24 | [0] Day Time Clock Mouse Listener 25 | [1] "MinimapFrame" 26 | [6] "CinematicPanel" 27 | [0] "CinematicPanelControlFrame" 28 | [0] "HDCinematicBackground" 29 | [1] "CinematicBottomBorder" 30 | [2] "CinematicScenePanel" 31 | [1] "CinematicPortraitBackground" 32 | [2] "CinematicPortrait" 33 | [3] "CinematicPortraitCover" 34 | [4] "HDCinematicPortraitCover" 35 | [5] "CinematicSpeakerText" 36 | [6] "CinematicDialogueText" 37 | [3] "CinematicTopBorder" 38 | [7] "ChatDialog"/"LogDialog" 39 | [0] "LogBackdrop" 40 | [1] "LogTitle" 41 | [2] "LogOkButton" 42 | [3] "LogAreaBackdrop" 43 | [0] "LogArea" 44 | ChatDialog takes LogDialogs Place in multiplayer 45 | [0] "ChatBackdrop" 46 | [1] "ChatTitle" 47 | [2] "ChatPlayerRadioButton" 48 | [3] "ChatAlliesRadioButton" 49 | [4] "ChatObserversRadioButton" 50 | [5] "ChatEveryoneRadioButton" 51 | [6] "ChatPlayerLabel" 52 | [7] "ChatAlliesLabel" 53 | [8] "ChatObserversLabel" 54 | [9] "ChatEveryoneLabel" 55 | [10] "ChatPlayerMenu" 56 | [11] "ChatAcceptButton" 57 | [12] "ChatHistoryDisplayBackdrop" 58 | [0] "ChatHistoryDisplay" 59 | [13] "ChatHistoryLabel" 60 | [14] "ChatInfoText" 61 | [8] "AllianceDialog" 62 | [0] "AllianceBackdrop" 63 | [1] "AllianceTitle" 64 | [2] "ResourceTradingTitle" 65 | [3] "PlayersHeader" 66 | [4] "AllyHeader" 67 | [5] "VisionHeader" 68 | [6] "UnitsHeader" 69 | [7] "GoldHeader" 70 | [8] "LumberHeader" 71 | [9] "AllianceAcceptButton" 72 | [10] "AllianceCancelButton" 73 | [11] "AlliedVictoryCheckBox" 74 | [12] "AlliedVictoryLabel" 75 | [13] "AllianceDialogScrollBar" 76 | [14 to 37] "AllianceSlot" 77 | [0] "ColorBackdrop" 78 | [0] "ColorBorder" 79 | [1] "PlayerNameLabel" 80 | [2] "AllyCheckBox" 81 | [3] "VisionCheckBox" 82 | [4] "UnitsCheckBox" 83 | [5] "GoldBackdrop" 84 | [0] "GoldText" 85 | [6] "LumberBackdrop" 86 | [0] "LumberText" 87 | [x] "Leaderboard" 88 | [0] "LeaderboardBackdrop" 89 | [1] "LeaderboardTitle" 90 | [2] "LeaderboardListContainer" 91 | [x] "Multiboard" 92 | [0] "MultiboardMinimizeButton" 93 | [1] "MultiboardTitleBackdrop" 94 | [2] "MultiboardTitle" 95 | [3] "MultiboardBackdrop" 96 | [4] "MultiboardListContainer" 97 | [0] Something 98 | [0 to rowCount - 1] row 99 | [0 to colCount - 1] cell 100 | [0] IconContainer 101 | [1] TextContainer 102 | [x] "TimerDialog" 103 | [0] "TimerDialogBackdrop" 104 | [1] "TimerDialogValue" 105 | [2] "TimerDialogTitle" 106 | [x] "QuestDialog" 107 | [9] No idea 108 | [0] 109 | [10] Inside Menu (F10) 110 | [0] "EscMenuBackdrop" 111 | [0] "EscMenuMainPanel" 112 | [0] "MainPanel" 113 | [0] "WouldTheRealOptionsTitleTextPleaseStandUp" 114 | [1] "InsideMainPanel" 115 | [0] "PauseButton" 116 | [1] "SaveGameButton" 117 | [2] "LoadGameButton" 118 | [3] "OptionsButton" 119 | [4] "HelpButton" 120 | [5] "TipsButton" 121 | [6] "EndGameButton" 122 | [7] "ReturnButton" 123 | [1] "EndGamePanel" 124 | [0] "InsideEndGamePanel" 125 | [0] "EndGameTitleText" 126 | [1] "RestartButton" 127 | [2] "QuitButton" 128 | [3] "ExitButton" 129 | [4] "PreviousButton" 130 | [2] "ConfirmQuitPanel" 131 | [0] "InsideConfirmQuitPanel" 132 | [0] "ConfirmQuitTitleText" 133 | [1] "ConfirmQuitMessageText" 134 | [2] "ConfirmQuitQuitButton" 135 | [3] "ConfirmQuitCancelButton" 136 | [3] "HelpPanel" 137 | [0] "InsideHelpPanel" 138 | [0] "HelpTitleText" 139 | [1] "HelpTextArea" 140 | [2] "HelpOKButton" 141 | [4] "TipsPanel" 142 | [0] "InsideTipsPanel" 143 | [0] "TipsTitleText" 144 | [1] "TipsTextArea" 145 | [2] "TipsBackButton" 146 | [3] "TipsNextButton" 147 | [4] "TipsOKButton" 148 | [1] "EscMenuOptionsPanel" 149 | [0] "OptionsPanel" 150 | [0] "OptionsTitleText" 151 | [1] "GameplayButton" 152 | [2] "VideoButton" 153 | [3] "SoundButton" 154 | [4] "NetworkButton" 155 | [5] "OptionsPreviousButton" 156 | [1] "GameplayPanel" 157 | [0] "GameplayTitleText" 158 | [1] "GameSpeedLabel" 159 | [2] "GameSpeedSlider" 160 | [3] "GameSpeedValue" 161 | [4] "MouseScrollLabel" 162 | [5] "MouseScrollSlider" 163 | [6] "MouseScrollSlowLabel" 164 | [7] "MouseScrollFastLabel" 165 | [8] "MouseScrollDisable" 166 | [9] "MouseScrollDisableLabel" 167 | [10] "KeyScrollLabel" 168 | [11] "KeyScrollSlider" 169 | [12] "KeyScrollSlowLabel" 170 | [13] "KeyScrollFastLabel" 171 | [14] "TooltipsCheckBox" 172 | [15] "TooltipsLabel" 173 | [16] "SubgroupCheckBox" 174 | [17] "SubgroupLabel" 175 | [18] "FormationToggleCheckBox" 176 | [19] "FormationToggleLabel" 177 | [20] "HealthBarsCheckBox" 178 | [21] "HealthBarsLabel" 179 | [22] "CustomKeysLabel" 180 | [23] "CustomKeysValue" 181 | [24] "DifficultyLabel" 182 | [25] "DifficultyValue" 183 | [2] "VideoPanel" 184 | [0] "VideoTitleText" 185 | [1] "GammaLabel" 186 | [2] "GammaSlider" 187 | [3] "GammaDarkLabel" 188 | [4] "GammaBrightLabel" 189 | [5] "WindowModeLabel" 190 | [6] "ResolutionLabel" 191 | [7] "VSyncLabel" 192 | [8] "ParticlesLabel" 193 | [9] "LightsLabel" 194 | [10] "ShadowsLabel" 195 | [11] "OcclusionLabel" 196 | [12] "ModelDetailLabel" 197 | [13] "ModelDetailValue" 198 | [14] "AnimQualityLabel" 199 | [15] "AnimQualityValue" 200 | [16] "TextureQualityLabel" 201 | [17] "TextureQualityValue" 202 | [18] "EscOptionsWindowModeMenu" 203 | [19] "EscOptionsResolutionMenu" 204 | [20] "VSyncCheckBox" 205 | [21] "EscOptionsParticlesMenu" 206 | [22] "EscOptionsLightsMenu" 207 | [23] "EscOptionsShadowsMenu" 208 | [24] "EscOptionsOcclusionMenu" 209 | [3] "SoundPanel" 210 | [0] "SoundTitleText" 211 | [1] "SoundCheckBox" 212 | [2] "SoundVolumeLabel" 213 | [3] "SoundVolumeSlider" 214 | [4] "SoundVolumeLowLabel" 215 | [5] "SoundVolumeHighLabel" 216 | [6] "MusicCheckBox" 217 | [7] "MusicVolumeLabel" 218 | [8] "MusicVolumeSlider" 219 | [9] "MusicVolumeLowLabel" 220 | [10] "MusicVolumeHighLabel" 221 | [11] "AmbientCheckBox" 222 | [12] "AmbientLabel" 223 | [13] "MovementCheckBox" 224 | [14] "MovementLabel" 225 | [15] "UnitCheckBox" 226 | [16] "UnitLabel" 227 | [17] "SubtitlesCheckBox" 228 | [18] "SubtitlesLabel" 229 | [19] "ProviderLabel" 230 | [20] "ProviderValue" 231 | [21] "EnviroCheckBox" 232 | [22] "EnviroLabel" 233 | [23] "PositionalCheckBox" 234 | [24] "PositionalLabel" 235 | [4] "NetworkPanel" 236 | [0] "NetworkTitleText" 237 | [1] "NetworkLabel" 238 | [2] "LatencyInfo1" 239 | [3] "LatencyInfo2" 240 | [4] "LowLatencyRadio" 241 | [5] "HighLatencyRadio" 242 | [6] "ExtraHighLatencyRadio" 243 | [7] "LowLatencyLabel" 244 | [8] "HighLatencyLabel" 245 | [9] "ExtraHighLatencyLabel" 246 | [5] "BottomButtonPanel" 247 | [0] "OptionsOKButton" 248 | [1] "OptionsCancelButton" 249 | [2] "EscMenuSaveGamePanel" 250 | [0] "EscMenuSaveLoadContainer" 251 | [0] "SaveAndLoad" 252 | [0] "FileListFrame" 253 | [0] "DecoratedMapListBox" 254 | [1] "LoadOnly" 255 | [0] "LoadGameTitleText" 256 | [1] "LoadGameLoadButton" 257 | [2] "LoadGameCancelButton" 258 | [2] "SaveOnly" 259 | [0] "SaveGameTitleText" 260 | [1] "SaveGameSaveButton" 261 | [2] "SaveGameDeleteButton" 262 | [3] "SaveGameCancelButton" 263 | [4] "SaveGameFileEditBox" 264 | [1] "EscMenuOverwriteContainer" 265 | [0] "OverwriteOnly" 266 | [0] "OverwriteTitleText" 267 | [1] "OverwriteMessageText" 268 | [2] "OverwriteOverwriteButton" 269 | [3] "OverwriteCancelButton" 270 | [2] "EscMenuDeleteContainer" 271 | [0] "DeleteOnly" 272 | [0] "DeleteTitleText" 273 | [1] "DeleteMessageText" 274 | [2] "DeleteDeleteButton" 275 | [3] "DeleteCancelButton" 276 | [11] Chat Input box 277 | [0] 278 | [1] 279 | [0] 280 | [0] 281 | [1] 282 | [2] 283 | [3] 284 | [4] 285 | [1] 286 | [2] 287 | [3] 288 | [12] Option Menu 289 | [0] "EscOptionsWindowModePopupMenuMenu" 290 | [1] "EscOptionsResolutionPopupMenuMenu" 291 | [2] "EscOptionsParticlesPopupMenuMenu" 292 | [3] "EscOptionsLightsPopupMenuMenu" 293 | [4] "EscOptionsShadowsPopupMenuMenu" 294 | [5] "EscOptionsOcclusionPopupMenuMenu" 295 | [13] Mouse Cursor (Parent) 296 |297 | 298 | 299 | 300 | -------------------------------------------------------------------------------- /navigation.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |