Difference between revisions of "UserStats object"
(user stats... this is insane) |
m (1 revision imported) |
(No difference)
| |
Latest revision as of 08:20, 1 December 2017
This object exposes information on a user's stats in the current Battle.net channel at the time of access.
Contents
- 1 History
- 2 How to use
- 3 Properties
- 3.1 List of properties
- 3.2 ToString property
- 3.3 Statstring property
- 3.4 IsValid property
- 3.5 Game property
- 3.6 Icon property
- 3.7 IconCode property
- 3.8 Clan property
- 3.9 IconName property
- 3.10 IconTier property
- 3.11 IsWCG property
- 3.12 Level property
- 3.13 ActsCompleted property
- 3.14 CharacterClass property
- 3.15 CharacterClassID property
- 3.16 CharacterFlags property
- 3.17 CharacterName property
- 3.18 CharacterTitle property
- 3.19 CurrentAct property
- 3.20 CurrentDifficulty property
- 3.21 CurrentDifficultyID property
- 3.22 IsCharacterDead property
- 3.23 IsExpansionCharacter property
- 3.24 IsFemaleCharacter property
- 3.25 IsHardcoreCharacter property
- 3.26 IsLadderCharacter property
- 3.27 Realm property
- 3.28 HighLadderRating property
- 3.29 IsSpawn property
- 3.30 LadderRank property
- 3.31 LadderRating property
- 3.32 Wins property
- 3.33 Dexterity property
- 3.34 Dots property
- 3.35 Gold property
- 3.36 Magic property
- 3.37 Strength property
- 3.38 Vitality property
- 4 See also
History
This object was added in StealthBot version 2.7 by Eric to create an object-oriented experience in scripting.
How to use
Example: Get the value of a property of a user's stats in channel at index Index.
Value = Channel.Users(Index).Stats.PropertyName
Properties
List of properties
(all games)
(WarCraft III)
(Diablo II)
- .ActsCompleted
- .CharacterClass
- .CharacterClassID
- .CharacterFlags
- .CharacterName
- .CharacterTitle
- .CurrentAct
- .CurrentDifficulty
- .CurrentDifficultyID
- .IsCharacterDead
- .IsExpansionCharacter
- .IsFemaleCharacter
- .IsHardcoreCharacter
- .IsLadderCharacter
- .Level
- .Realm
(StarCraft or WarCraft II)
(Diablo)
ToString property
Returns the parsed stats as a string.
Statstring property
Returns the unparsed stats as a string.
IsValid property
Returns True if this object was created with a valid stat string.
Game property
Returns the four-character product ID for the game that this stat object represents.
Icon property
Returns the four-character icon ID for the icon (ignoring flags).
IconCode property
Returns the index for the internal image list for the icon to display (not ignoring flags).
Clan property
Returns the two-to-four-character Battle.net clan tag for the user, or an empty string if in none. WarCraft III users only.
IconName property
Returns the full name of the icon. WarCraft III users only.
IconTier property
Returns the full icon tier name. WarCraft III users only.
IsWCG property
Returns whether this user has a World Cyber Games icon. WarCraft III users only.
Level property
Returns the WarCraft III level for WarCraft III users or the character level for Diablo or closed Battle.net Diablo II users, or 0 for StarCraft or WarCraft II users.
ActsCompleted property
Returns the number of acts completed for a closed Battle.net Diablo II character.
CharacterClass property
Returns the full class name of the Diablo or closed Battle.net Diablo II character.
CharacterClassID property
Returns the class ID of the Diablo or closed Battle.net Diablo II character.
CharacterFlags property
Returns the numeric flags of the closed Battle.net Diablo II character.
CharacterName property
Returns the name of the closed Battle.net Diablo II character.
CharacterTitle property
Returns the title of the closed Battle.net Diablo II character.
CurrentAct property
Returns the current act of the closed Battle.net Diablo II character.
CurrentDifficulty property
Returns the name of the current difficulty of the closed Battle.net Diablo II character.
CurrentDifficultyID property
Returns the numeric ID of the current difficulty of the closed Battle.net Diablo II character.
IsCharacterDead property
Returns True if the closed Battle.net Diablo II character is dead on Hardcore mode.
IsExpansionCharacter property
Returns True if the closed Battle.net Diablo II character is a Diablo II: Lord of Destruction character.
IsFemaleCharacter property
Returns True if the closed Battle.net Diablo II character is a character class that is female (Amazon, Sorceress, or Assassin).
IsHardcoreCharacter property
Returns True if the closed Battle.net Diablo II character is on Hardcore mode.
IsLadderCharacter property
Returns True if the closed Battle.net Diablo II character is on the Ladder.
Realm property
Returns the name of the closed Battle.net Diablo II character's realm as a string.
HighLadderRating property
Returns the user's high ladder rating. StarCraft or WarCraft II users only.
IsSpawn property
Returns whether the user is on a spawned copy of the game. StarCraft Original, StarCraft Japanese, or WarCraft II users only.
LadderRank property
Returns the user's ladder rank. StarCraft or WarCraft II users only.
LadderRating property
Returns the user's ladder rating. StarCraft or WarCraft II users only.
Wins property
Returns the number of times the user has won. StarCraft or WarCraft II users only.
Dexterity property
Returns the numeric dexterity property of the character. Diablo users only.
Dots property
Returns the numeric dots the character has earned. Each dot represents a level of difficulty defeated. Diablo users only.
Gold property
Returns the numeric amount of gold the character holds. Diablo users only.
Magic property
Returns the numeric magic property of the character. Diablo users only.
Strength property
Returns the numeric strength property of the character. Diablo users only.
Vitality property
Returns the numeric vitality property of the character. Diablo users only.
