v0.13.8

C_UIWidgetManager

namespaceavailable in: camelot

Status in wowlua

42 functions: 0 implemented, 6 recorded, 36 guessed. 2 events, 1 of them fired by the emulator on its own.

Functions

functionwhat it doesstatus
GetAllWidgetsBySetIDReturns all widgets for a widget set ID.
(setID: number): UIWidgetInfo[]
recorded
GetBelowMinimapWidgetSetIDReturns the ID of the widget set shown below the minimap. · by wowlua
(): number
recorded
GetBulletTextListWidgetVisualizationInfoReturns what a bullet text list UI widget shows. · by wowlua
(widgetID: number): BulletTextListWidgetVisualizationInfo?
guessed
GetButtonHeaderWidgetVisualizationInfoReturns what a button header UI widget shows. · by wowlua
(widgetID: number): ButtonHeaderWidgetVisualizationInfo?
guessed
GetCaptureBarWidgetVisualizationInfoReturns what a capture bar UI widget shows. · by wowlua
(widgetID: number): CaptureBarWidgetVisualizationInfo?
guessed
GetCaptureZoneVisualizationInfoReturns what a capture zone UI widget shows. · by wowlua
(widgetID: number): CaptureZoneVisualizationInfo?
guessed
GetDiscreteProgressStepsVisualizationInfoThe DiscreteProgressSteps UI Widget is used for the Eye of the Jailer display while in the Maw.
(widgetID: number): DiscreteProgressStepsVisualizationInfo?
guessed
GetDoubleIconAndTextWidgetVisualizationInfoReturns what a double icon and text UI widget shows. · by wowlua
(widgetID: number): DoubleIconAndTextWidgetVisualizationInfo?
guessed
GetDoubleStateIconRowVisualizationInfoReturns what a double state icon row UI widget shows. · by wowlua
(widgetID: number): DoubleStateIconRowVisualizationInfo?
guessed
GetDoubleStatusBarWidgetVisualizationInfoReturns what a double status bar UI widget shows. · by wowlua
(widgetID: number): DoubleStatusBarWidgetVisualizationInfo?
guessed
GetFillUpFramesWidgetVisualizationInfoReturns what a fill-up frames UI widget shows. · by wowlua
(widgetID: number): FillUpFramesWidgetVisualizationInfo?
guessed
GetHorizontalCurrenciesWidgetVisualizationInfoReturns what a horizontal currencies UI widget shows. · by wowlua
(widgetID: number): HorizontalCurrenciesWidgetVisualizationInfo?
guessed
GetIconAndTextWidgetVisualizationInfoReturns what a icon and text UI widget shows. · by wowlua
(widgetID: number): IconAndTextWidgetVisualizationInfo?
guessed
GetIconTextAndBackgroundWidgetVisualizationInfoReturns what a icon, text and background UI widget shows. · by wowlua
(widgetID: number): IconTextAndBackgroundWidgetVisualizationInfo?
guessed
GetIconTextAndCurrenciesWidgetVisualizationInfoReturns what a icon, text and currencies UI widget shows. · by wowlua
(widgetID: number): IconTextAndCurrenciesWidgetVisualizationInfo?
guessed
GetItemDisplayVisualizationInfoReturns what a item display UI widget shows. · by wowlua
(widgetID: number): ItemDisplayVisualizationInfo?
guessed
GetMapPinAnimationWidgetVisualizationInfoReturns what a map pin animation UI widget shows. · by wowlua
(widgetID: number): MapPinAnimationWidgetVisualizationInfo?
guessed
GetObjectiveTrackerWidgetSetIDReturns the ID of the widget set shown in the objective tracker. · by wowlua
(): number
recorded
GetPowerBarWidgetSetIDReturns the ID of the widget set shown as the encounter power bar. · by wowlua
(): number
recorded
GetPreyHuntProgressWidgetVisualizationInfoReturns what a prey hunt progress UI widget shows. · by wowlua
(widgetID: number): PreyHuntProgressWidgetVisualizationInfo?
guessed
GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfoReturns what a scenario header with currencies and background UI widget shows. · by wowlua
(widgetID: number): ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo?
guessed
GetScenarioHeaderDelvesWidgetVisualizationInfoReturns what a delves scenario header UI widget shows. · by wowlua
(widgetID: number): ScenarioHeaderDelvesWidgetVisualizationInfo?
guessed
GetScenarioHeaderTimerWidgetVisualizationInfoReturns what a scenario header timer UI widget shows. · by wowlua
(widgetID: number): ScenarioHeaderTimerWidgetVisualizationInfo?
guessed
GetSpacerVisualizationInfoReturns what a spacer UI widget shows. · by wowlua
(widgetID: number): SpacerVisualizationInfo?
guessed
GetSpellDisplayVisualizationInfoReturns what a spell display UI widget shows. · by wowlua
(widgetID: number): SpellDisplayVisualizationInfo?
guessed
GetStackedResourceTrackerWidgetVisualizationInfoReturns what a stacked resource tracker UI widget shows. · by wowlua
(widgetID: number): StackedResourceTrackerWidgetVisualizationInfo?
guessed
GetStatusBarWidgetVisualizationInfoReturns what a status bar UI widget shows. · by wowlua
(widgetID: number): StatusBarWidgetVisualizationInfo?
guessed
GetTextColumnRowVisualizationInfoReturns what a text column row UI widget shows. · by wowlua
(widgetID: number): TextColumnRowVisualizationInfo?
guessed
GetTextWithStateWidgetVisualizationInfoReturns what a text with state UI widget shows. · by wowlua
(widgetID: number): TextWithStateWidgetVisualizationInfo?
guessed
GetTextWithSubtextWidgetVisualizationInfoReturns what a text with subtext UI widget shows. · by wowlua
(widgetID: number): TextWithSubtextWidgetVisualizationInfo?
guessed
GetTextureAndTextRowVisualizationInfoReturns what a texture and text row UI widget shows. · by wowlua
(widgetID: number): TextureAndTextRowVisualizationInfo?
guessed
GetTextureAndTextVisualizationInfoReturns what a texture and text UI widget shows. · by wowlua
(widgetID: number): TextureAndTextVisualizationInfo?
guessed
GetTextureWithAnimationVisualizationInfoReturns what a texture with animation UI widget shows. · by wowlua
(widgetID: number): TextureWithAnimationVisualizationInfo?
guessed
GetTopCenterWidgetSetIDReturns the widget set ID for the top center part of the screen.
(): number
recorded
GetTugOfWarWidgetVisualizationInfoReturns what a tug of war UI widget shows. · by wowlua
(widgetID: number): TugOfWarWidgetVisualizationInfo?
guessed
GetUnitPowerBarWidgetVisualizationInfoReturns what a unit power bar UI widget shows. · by wowlua
(widgetID: number): UnitPowerBarWidgetVisualizationInfo?
guessed
GetWidgetSetInfoReturns information about the widget set, such as its layout. · by wowlua
(widgetSetID: number): UIWidgetSetInfo?
recorded
GetZoneControlVisualizationInfoReturns what a zone control UI widget shows. · by wowlua
(widgetID: number): ZoneControlVisualizationInfo?
guessed
RegisterUnitForWidgetUpdatesRegisters the unit so its UI widgets get updates. · by wowlua
(unitToken: string, isGuid: boolean)
guessed
SetProcessingUnitSets the unit whose UI widgets are processed. · by wowlua
(unit: string?)
guessed
SetProcessingUnitGuidSets the unit, by GUID, whose UI widgets are processed. · by wowlua
(unit: string?)
guessed
UnregisterUnitForWidgetUpdatesStops UI widget updates for the unit. · by wowlua
(unitToken: string, isGuid: boolean)
guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

eventpayloadfired by the emulator
UPDATE_ALL_UI_WIDGETSno payloadimplemented
UPDATE_UI_WIDGETwidgetInfo: UIWidgetInfonot implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("UPDATE_UI_WIDGET").

Structures

  • BulletTextListWidgetVisualizationInfo · shownState, enabledState, lines, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • ButtonHeaderWidgetVisualizationInfo · shownState, headerText, tooltip, tooltipLoc, buttons, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • CaptureBarWidgetVisualizationInfo · shownState, barValue, barMinValue, barMaxValue, neutralZoneSize, neutralZoneCenter, tooltip, glowAnimType, fillDirectionType, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • CaptureZoneVisualizationInfo · shownState, mode, leadingEdgeType, dangerFlashType, zoneInfo, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • DiscreteProgressStepsVisualizationInfo · shownState, tooltip, progressMin, progressMax, progressVal, numSteps, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • DoubleIconAndTextWidgetVisualizationInfo · shownState, label, leftText, leftTooltip, rightText, rightTooltip, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • DoubleStateIconRowVisualizationInfo · shownState, leftIcons, rightIcons, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • DoubleStatusBarWidgetVisualizationInfo · shownState, leftBarMin, leftBarMax, leftBarValue, leftBarTooltip, rightBarMin, rightBarMax, rightBarValue, rightBarTooltip, barValueTextType, text, leftBarTooltipLoc, rightBarTooltipLoc, fillMotionType, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • FillUpFramesWidgetVisualizationInfo · shownState, fillMin, fillMax, fillValue, numTotalFrames, numFullFrames, pulseFillingFrame, tooltip, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • HorizontalCurrenciesWidgetVisualizationInfo · shownState, currencies, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • IconAndTextWidgetVisualizationInfo · state, text, tooltip, dynamicTooltip, tooltipLoc, shiftTextType, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • IconTextAndBackgroundWidgetVisualizationInfo · shownState, text, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • IconTextAndCurrenciesWidgetVisualizationInfo · shownState, enabledState, descriptionShownState, descriptionEnabledState, text, description, currencies, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • ItemDisplayVisualizationInfo · shownState, tooltipLoc, itemInfo, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • MapPinAnimationWidgetVisualizationInfo · shownState, animType, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • PreyHuntProgressWidgetVisualizationInfo · shownState, progressState, tooltip, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo · shownState, currencies, headerText, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • ScenarioHeaderDelvesWidgetVisualizationInfo · shownState, headerText, tooltip, tooltipLoc, tierText, tierTooltipSpellID?, currencies, spells, rewardInfo, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • ScenarioHeaderTimerWidgetVisualizationInfo · shownState, timerMin, timerMax, timerValue, headerText, timerTooltip, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • SpacerVisualizationInfo · shownState, widgetWidth, widgetHeight, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • SpellDisplayVisualizationInfo · spellInfo, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • StackedResourceTrackerWidgetVisualizationInfo · shownState, resources, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • StatusBarWidgetVisualizationInfo · shownState, barMin, barMax, barValue, text, tooltip, barValueTextType, overrideBarText, overrideBarTextShownType, colorTint, partitionValues, tooltipLoc, fillMotionType, barTextEnabledState, barTextFontType, barTextSizeType, textEnabledState, textFontType, textSizeType, glowAnimType, showGlowState, fillMinOpacity, fillMaxOpacity, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • TextColumnRowEntryInfo · text, enabledState, hAlign, columnWidth
  • TextColumnRowVisualizationInfo · shownState, entries, textSizeType, fontType, tooltip, tooltipLoc, bottomPadding, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • TextureAndTextEntryInfo · text, tooltip
  • TextureAndTextRowVisualizationInfo · shownState, entries, textSizeType, groupAlignment, fixedWidth?, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • TextureAndTextVisualizationInfo · shownState, text, tooltip, tooltipLoc, textSizeType, textFormatType, updateAnimType, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • TextureWithAnimationVisualizationInfo · shownState, tooltip, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • TextWithStateWidgetVisualizationInfo · shownState, enabledState, text, tooltip, textSizeType, fontType, bottomPadding, tooltipLoc, hAlign, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • TextWithSubtextWidgetVisualizationInfo · shownState, enabledState, text, widgetWidth, tooltip, textSizeType, fontType, tooltipLoc, hAlign, subText, subTextSizeType, subTextFontType, subTextHAlign, subTextEnabledState, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID, spacing
  • TugOfWarWidgetVisualizationInfo · shownState, minValue, maxValue, currentValue, neutralZoneCenter, neutralZoneSize, leftIconInfo, rightIconInfo, glowAnimType, tooltip, tooltipLoc, neutralFillStyle, markerArrowShownState, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • UIWidgetCurrencyInfo · iconFileID, leadingText, text, tooltip, isCurrencyMaxed, textFontType, textSizeType, textEnabledState, iconSizeType, updateAnimType
  • UIWidgetIconInfo · sourceType, sourceID, sizeType, tooltip, tooltipLoc
  • UIWidgetInfo · widgetID, widgetSetID, widgetType, unitToken?
  • UIWidgetItemInfo · itemID, stackCount?, overrideItemName?, infoText?, overrideTooltip?, textDisplayStyle, tooltipEnabled, iconSizeType, infoTextEnabledState, showAsEarned, itemNameTextFontType, itemNameTextSizeType, infoTextFontType, infoTextSizeType, itemNameCustomColor, itemNameCustomColorOverrideState
  • UIWidgetRewardInfo · shownState, earnedTooltip, unearnedTooltip
  • UIWidgetSetInfo · layoutDirection, verticalPadding
  • UIWidgetSpellButtonInfo · spellID, tooltip, icon, enabledState, cooldownType
  • UIWidgetSpellInfo · spellID, shownState, enabledState, tooltip, text, stackDisplay, iconSizeType, iconDisplayType, textShownState, borderColor, textFontType, textSizeType, hAlignType, tint, showGlowState, showAsEarned
  • UIWidgetStateIconInfo · iconState, state1Tooltip, state2Tooltip
  • UIWidgetTextTooltipPair · text, tooltip
  • UnitPowerBarWidgetVisualizationInfo · shownState, barMin, barMax, barValue, tooltip, barValueTextType, overrideBarText, overrideBarTextShownType, tooltipLoc, fillMotionType, flashBlendModeType, sparkBlendModeType, flashMomentType, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • ZoneControlVisualizationInfo · shownState, mode, leadingEdgeType, dangerFlashType, zoneEntries, tooltipLoc, widgetSizeSetting, textureKit, frameTextureKit, hasTimer, orderIndex, widgetTag, inAnimType, outAnimType, widgetScale, layoutDirection, modelSceneLayer, scriptedAnimationEffectID
  • ZoneEntry · state, activeState, fillType, min, max, current, capturePoint, tooltip

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (UIWidgetManager system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.