Changes: API GetArtifactProgress

Revision as of 08:02, 3 March 2011

Returns the information for a specific race's active artifact.

artifactName, artifactDescription, artifactRarity, artifactIcon, hoverDescription, keystoneCount, bgTexture, firstCompletionTime, completionCount = GetActiveArtifactByRace(raceIndex);

Arguments

raceIndex: Integer - Index of the race to pick the artifact from.

Returns

artifactName: String - The name of the artifact.
artifactDescription: String - The description displayed on the artifact detail page. Only visible after completion for rare artifacts.
artifactRarity: Integer - The rarity of the artifact, 0 for Common and 1 for Rare.
artifactIcon: String - The path to the artifact's icon texture.
hoverDescription: String - The description shown in the tooltip when hovering over the completed artifact. Not visible before the artifact is completed.
keystoneCount: Integer - The number of Keystone slots this artifact has. Only visible when this is the in progress artifact.
bgTexture: String - The path to the artifact's background texture. Only displayed when the artifact is rare.
firstCompletionTime: Integer - The first time the artifact was ever completed, in the same format as time().
completionCount: Integer - The number of times this artifact has been completed.

Details

The formatting used in the US client for the display of the firstCompletionTime tooltip is "%m/%d/%y %I:%M %p". You can view this formatting using the date() function and the firstCompletionTime.

Also See

GetActiveArtifactByRace(raceIndex, artifactIndex);

GetSelectedArtifactInfo();

ru:Справка:Статьи о функциях API/Предварительная загрузка

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
 <!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
-Returns information about current used fragments for the selected artifact.
+Returns the information for a specific race's active artifact.
 <!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+ artifactName, artifactDescription, artifactRarity, artifactIcon, hoverDescription, keystoneCount, bgTexture, firstCompletionTime, completionCount = GetActiveArtifactByRace(raceIndex);
- numFragmentsCollected, numFragmentsAdded, numFragmentsRequired = GetArtifactProgress();
-== Returns ==
+== Arguments ==
 <!-- List each argument, together with its type -->
+;raceIndex : Integer - Index of the race to pick the artifact from.
+== Returns ==
-;numFragmentsCollected : Number - Number of collected fragments for selected artifact.
+<!-- List each return value, together with its type -->
-;numFragmentsAdded : Number - Number of fragments currently added through keystones for selected artifact.
-;numFragmentsRequired : Number - Number of fragments required to solve the selected artifact.
+;artifactName : String - The name of the artifact.
+;artifactDescription : String - The description displayed on the artifact detail page. Only visible after completion for rare artifacts.
+;artifactRarity : Integer - The rarity of the artifact, 0 for Common and 1 for Rare.
-== Example ==
+;artifactIcon : String - The path to the artifact's icon texture.
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
+;hoverDescription : String - The description shown in the tooltip when hovering over the completed artifact. Not visible before the artifact is completed.
-My selected Project requires 45 fragments, i have 22 fragments and a [[Keystone]] slot which i do not use.
+;keystoneCount : Integer - The number of [[Keystone]] slots this artifact has. Only visible when this is the in progress artifact.
-<big>'''Result'''</big>
+;bgTexture : String - The path to the artifact's background texture. Only displayed when the artifact is rare.
-0 45
+;firstCompletionTime : Integer - The first time the artifact was ever completed, in the same format as time().
-The same project, this time the [[Keystone]] slot is used.
+;completionCount : Integer - The number of times this artifact has been completed.
-<big>'''Result'''</big>
-12 45
-<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->
+== Details ==
-The following functions are getting pointed to the current nightelf-project (raceIndex 4)
+: The formatting used in the US client for the display of the firstCompletionTime tooltip is "%m/%d/%y %I:%M %p". You can view this formatting using the date() function and the firstCompletionTime.
 == Also See ==
+: [[API GetArtifactInfoByRace|GetActiveArtifactByRace]](raceIndex, artifactIndex);
-: [[API SocketItemToArtifact|SocketItemToArtifact]]()
-: [[API RemoveItemFromArtifact|RemoveItemFromArtifact]]()
+: [[API GetSelectedArtifactInfo|GetSelectedArtifactInfo]]();
-: [[API CanItemBeSocketedToArtifact|CanItemBeSocketedToArtifact]](itemID)
-: [[API GetActiveArtifactByRace|GetActiveArtifactByRace]](raceIndex)
-: [[API GetSelectedArtifactInfo|GetSelectedArtifactInfo]]()
-: [[API GetArtifactProgress|GetArtifactProgress]]()
 <noinclude>[[ru:Справка:Статьи о функциях API/Предварительная загрузка]]</noinclude>