C_ArtifactUI

namespaceavailable in: camelot

Status in wowlua

62 functions: 0 implemented, 2 recorded, 60 guessed. 10 events, 1 of them fired by the emulator on its own.

Functions

function	what it does	status
`AddPower`	Spends a point on the artifact power. · by wowlua `(powerID: number): boolean`	guessed
`ApplyCursorRelicToSlot`	Puts the relic on the cursor into the artifact's relic slot. · by wowlua `(relicSlotIndex: number)`	guessed
`CanApplyArtifactRelic`	Whether the relic fits the artifact. · by wowlua `(relicItemID: number, onlyUnlocked: boolean): boolean`	guessed
`CanApplyCursorRelicToSlot`	Whether the relic on the cursor fits the artifact's relic slot. · by wowlua `(relicSlotIndex: number): boolean`	guessed
`CanApplyRelicItemIDToEquippedArtifactSlot`	Whether the relic fits the equipped artifact's relic slot. · by wowlua `(relicItemID: number, relicSlotIndex: number): boolean`	guessed
`CanApplyRelicItemIDToSlot`	Whether the relic fits the artifact's relic slot. · by wowlua `(relicItemID: number, relicSlotIndex: number): boolean`	guessed
`CheckRespecNPC`	Whether the player is at an NPC that resets artifact powers. · by wowlua `(): boolean`	guessed
`Clear`	Clears data of the last opened artifact weapon. `()`	guessed
`ClearForgeCamera`	Resets the camera of the artifact forge. · by wowlua `()`	guessed
`ConfirmRespec`	Confirms resetting the artifact's powers. · by wowlua `()`	guessed
`DoesEquippedArtifactHaveAnyRelicsSlotted`	Whether the equipped artifact has a relic in any slot. · by wowlua `(): boolean`	guessed
`GetAppearanceInfo`	Returns information about a selected artifact appearance. `(appearanceSetIndex: number, appearanceIndex: number): (number?, string?, number?, boolean?, string?, number?, number?, number?, number?, number?, number?, number?, boolean?)`	guessed
`GetAppearanceInfoByID`	Returns information about a selected artifact appearance. `(artifactAppearanceID: number): (number?, number?, string?, number?, boolean?, string?, number?, number?, number?, number?, number?, number?, number?, boolean?)`	guessed
`GetAppearanceSetInfo`	Returns information about the artifact's appearance set. · by wowlua `(appearanceSetIndex: number): (number?, string?, string?, number?)`	guessed
`GetArtifactArtInfo`	Returns information about the currently equipped artifact weapon. `(): ArtifactArtInfo?`	guessed
`GetArtifactInfo`	Returns information about the currently equipped artifact weapon. `(): (number?, number?, string?, number?, number?, number?, number?, number?, number?, number?, number?, boolean?, ArtifactTiers?)`	guessed
`GetArtifactItemID`	Returns the item ID of the artifact being viewed. · by wowlua `(): number?`	guessed
`GetArtifactTier`	Returns the tier number for your artifact at the forge. `(): ArtifactTiers?`	guessed
`GetArtifactXPRewardTargetInfo`	Returns the name and icon of the artifact that gets the artifact power reward of the category. · by wowlua `(artifactCategoryID: number): (string?, number?)`	guessed
`GetCostForPointAtRank`	Returns the artifact power a point costs at the rank. · by wowlua `(rank: number, tier: ArtifactTiers): number`	guessed
`GetEquippedArtifactArtInfo`	Returns the art of the equipped artifact. · by wowlua `(): ArtifactArtInfo?`	guessed
`GetEquippedArtifactInfo`	Returns information about the equipped artifact. · by wowlua `(): (number?, number?, string?, number?, number?, number?, number?, number?, number?, number?, number?, boolean?, ArtifactTiers?)`	recorded
`GetEquippedArtifactItemID`	Returns the item ID of the equipped artifact. · by wowlua `(): number?`	guessed
`GetEquippedArtifactNumRelicSlots`	Returns the number of relic slots of the equipped artifact. · by wowlua `(onlyUnlocked: boolean): number`	guessed
`GetEquippedArtifactRelicInfo`	Returns information about the relic in the equipped artifact's slot. · by wowlua `(relicSlotIndex: number): (string?, number?, string?, string?)`	guessed
`GetEquippedRelicLockedReason`	Returns why the equipped artifact's relic slot is locked, or nil when it is not. · by wowlua `(relicSlotIndex: number): string?`	guessed
`GetForgeRotation`	Returns the rotation of the artifact shown at the forge. · by wowlua `(): (number, number, number)`	guessed
`GetItemLevelIncreaseProvidedByRelic`	Returns how much item level the relic adds to an artifact. · by wowlua `(itemLinkOrID: ItemInfo): number?`	guessed
`GetMetaPowerInfo`	Returns information about the artifact's final power. · by wowlua `(): (number, number, number)`	guessed
`GetNumAppearanceSets`	Returns the number of the artifact's appearance sets. · by wowlua `(): number`	guessed
`GetNumObtainedArtifacts`	Returns the number of artifacts the player has obtained. · by wowlua `(): number`	guessed
`GetNumRelicSlots`	Returns the number of relic slots of the artifact being viewed. · by wowlua `(onlyUnlocked: boolean): number`	guessed
`GetPointsRemaining`	Returns the number of points the artifact has left to spend. · by wowlua `(): number`	guessed
`GetPowerHyperlink`	Returns a chat link to the artifact power. · by wowlua `(powerID: number): string`	guessed
`GetPowerInfo`	Returns information about the artifact power. · by wowlua `(powerID: number): ArtifactPowerInfo?`	guessed
`GetPowerLinks`	Returns the IDs of the powers connected to the artifact power. · by wowlua `(powerID: number): number[]`	guessed
`GetPowers`	Returns the IDs of the artifact's powers. · by wowlua `(): number[]?`	guessed
`GetPowersAffectedByRelic`	Returns the IDs of the powers the relic in the slot improves. · by wowlua `(relicSlotIndex: number): number`	guessed
`GetPowersAffectedByRelicItemLink`	Returns the IDs of the powers the relic improves. · by wowlua `(relicItemInfo: ItemInfo): number`	guessed
`GetPreviewAppearance`	Returns the ID of the artifact appearance being previewed. · by wowlua `(): number?`	guessed
`GetRelicInfo`	Returns information about the relic in the artifact's slot. · by wowlua `(relicSlotIndex: number): (string?, number?, string?, string?)`	guessed
`GetRelicInfoByItemID`	Returns information about the relic. · by wowlua `(itemID: number): (string?, number?, string?, string?)`	guessed
`GetRelicLockedReason`	Returns why the artifact's relic slot is locked, or nil when it is not. · by wowlua `(relicSlotIndex: number): string?`	guessed
`GetRelicSlotType`	Returns the type of relic the artifact's slot takes. · by wowlua `(relicSlotIndex: number): string?`	guessed
`GetRespecArtifactArtInfo`	Returns the art of the artifact whose powers are being reset. · by wowlua `(): ArtifactArtInfo?`	guessed
`GetRespecArtifactInfo`	Returns information about the artifact whose powers are being reset. · by wowlua `(): (number?, number?, string?, number?, number?, number?, number?, number?, number?, number?, number?, boolean?, ArtifactTiers?)`	guessed
`GetRespecCost`	Returns the cost of resetting the artifact's powers. · by wowlua `(): number`	guessed
`GetTotalPowerCost`	Returns the total artifact power the traits cost from the starting rank on. · by wowlua `(startingTrait: number, numTraits: number, artifactTier: ArtifactTiers): number?`	guessed
`GetTotalPurchasedRanks`	Returns the total number of ranks purchased for an artifact weapon. `(): number`	guessed
`IsArtifactDisabled`	Whether the artifact being viewed is disabled. · by wowlua `(): boolean`	guessed
`IsArtifactItem`	Whether the item is an artifact. · by wowlua `(itemLocation: ItemLocationMixin): boolean`	guessed
`IsAtForge`	Whether the player is at an artifact forge. · by wowlua `(): boolean`	recorded
`IsEquippedArtifactDisabled`	Whether the equipped artifact is disabled. · by wowlua `(): boolean`	guessed
`IsEquippedArtifactMaxed`	Whether the equipped artifact has all its powers. · by wowlua `(): boolean`	guessed
`IsMaxedByRulesOrEffect`	Whether the artifact can gain no more powers. · by wowlua `(): boolean`	guessed
`IsPowerKnown`	Whether the artifact has the power. · by wowlua `(powerID: number): boolean`	guessed
`IsViewedArtifactEquipped`	Whether the artifact being viewed is equipped. · by wowlua `(): boolean`	guessed
`SetAppearance`	Sets the artifact's appearance. · by wowlua `(artifactAppearanceID: number)`	guessed
`SetForgeCamera`	Sets the camera to the artifact forge's view. · by wowlua `()`	guessed
`SetForgeRotation`	Sets the rotation of the artifact shown at the forge. · by wowlua `(forgeRotationX: number, forgeRotationY: number, forgeRotationZ: number)`	guessed
`SetPreviewAppearance`	Call without an argument to clear the preview. `(artifactAppearanceID: number)`	guessed
`ShouldSuppressForgeRotation`	Whether the artifact shown at the forge should not rotate. · by wowlua `(): boolean`	guessed

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

Events

event	payload	fired by the emulator
`ARTIFACT_CLOSE`	`no payload`	implemented
`ARTIFACT_ENDGAME_REFUND`	`numRefundedPowers: number, refundedTier: ArtifactTiers, bagOrSlotIndex: number, slotIndex: number?`	not implemented
`ARTIFACT_RELIC_FORGE_CLOSE`	`no payload`	not implemented
`ARTIFACT_RELIC_FORGE_PREVIEW_RELIC_CHANGED`	`no payload`	not implemented
`ARTIFACT_RELIC_FORGE_UPDATE`	`no payload`	not implemented
`ARTIFACT_RELIC_INFO_RECEIVED`	`no payload`	not implemented
`ARTIFACT_RESPEC_PROMPT`	`no payload`	not implemented
`ARTIFACT_TIER_CHANGED`	`newTier: number, bagOrSlotIndex: number, slotIndex: number?`	not implemented
`ARTIFACT_UPDATE`	`newItem: boolean`	not implemented
`ARTIFACT_XP_UPDATE`	`no payload`	not implemented

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

Structures

ArtifactAppearanceInfo · artifactAppearanceID, appearanceName, displayIndex, unlocked, failureDescription?, uiCameraID, altHandCameraID?, swatchColor, modelOpacity, modelSaturation, obtainable
ArtifactAppearanceSetInfo · artifactAppearanceSetID, appearanceSetName, appearanceSetDescription, numAppearances
ArtifactArtInfo · textureKit, titleName, titleColor, barConnectedColor, barDisconnectedColor, uiModelSceneID, spellVisualKitID
ArtifactInfo · itemID, altItemID?, name, icon, xp, pointsSpent, quality, artifactAppearanceID, appearanceModID, itemAppearanceID?, altItemAppearanceID?, altOnTop, tier
ArtifactMetaPowerInfo · spellID, powerCost, currentRank
ArtifactPowerInfo · spellID, cost, currentRank, maxRank, bonusRanks, numMaxRankBonusFromTier, prereqsMet, isStart, isGoldMedal, isFinal, tier, position, offset?, linearIndex?
ArtifactRelicInfo · name, icon, slotTypeName, link

sources

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