API types

From Wowpedia
Jump to: navigation, search

The World of Warcraft API uses rather complex values for some arguments and return values. Rather than re-explain them every time they're used, we document them as distinct data types (though in reality they're numbers and strings).

Complex World of Warcraft API Data Types

actionSlot - Action button slot numbers (120 in total)
auctionSortId - An identifier for sorting columns in the auction house.
auctionTypeId - An identifier specifying which type of auction to operate on.
bagId - Numbers representing bags you carry, bank bags, bank window, etc
bagType - A bittype identifier representing the type of bags an item can go into or the type of items a bag can carry (New in 2.4.0)
chatTypeId - An identifier for the different chat destination types.
emoteToken - System names of voice/action emotes
enchantString - An enchant id.
enchantLink - A string that will be clickable, if shown in-game, contains an enchantString.
GUID - A unique identifier for everything that can be interacted with.
inventorySlotId - Current mappings of slot names to numbers. May change.
inventorySlotName - Names of inventory slots.
itemEquipLoc - String representation of where an item may be equipped ("INVTYPE_HEAD", etc)
itemString - An item id with data about enchants, "of" type bonuses, and the item's creator.
itemLink - A string that will be clickable if shown in-game, contains an itemString.
itemType - String classification of an item, ("Armor", "Consumable", etc)
lootMethod - An identifier for the different looting methods (group loot, need before greed, etc)
playerName - The name of a player.
questID - A unique numeric identifier for quests.
questLink - A string that will be clickable, if shown in-game, contains a questString.
questString - A quest id with data about the quest, including the level and quest title.
raidIndex - A number between 1 and 40
standingId - Numeric encoding of faction standing.
unitId - An identifier which specifies one of the units the API may reference ("target", "party1", etc)
unitFlag - A bittype indentifier for the relationship between the player and a unit in the combat log (New in 2.4.0)

Types with an expanding list of IDs.

ArtifactAppearanceID - Numeric identifier for Artifact skins.
AtlasID - A string identifier for textures with a preset size, tex coords and wrap mode.
BattlePetSpeciesID - Numeric identifier for Battle Pets.
BuildingID - Numeric identifier for Garrison Buildings.
ClassId - Numeric identifier for character classes.
CreatureDisplayID - Numeric identifier for unit models.
CurrencyID - Numeric identifier for Currencies.
DifficultyID - Numeric identifier for dungeon and raid difficulty.
DungeonEncounterID - Numeric identifier for boss encounters.
FactionID - Numeric identifier for Factions.
FileID - A unique identifier for a client-accessible internal file (such as textures or models).
InstanceID - Numeric identifier for physical map instances, such as Zones and Continents.
UiMapID - Numeric identifier for user interface Maps, as used for the WorldMapFrame. Replaces WorldMapAreaID.
JournalEncounterID - Numeric identifier for Adventure Journal bossses.
LanguageID - Numeric identifier for Languages.
LfgDungeonID - Numeric identifier for LFG instances.
MountID - Numeric identifier for Mounts.
MovieID - Numeric identifier for pre-rendered movies.
RaceId - Numeric identifier for both player and NPC races.
SpecializationID - Numeric identifier for class Specializations.
TitleId - Numeric identifier for player Titles.
ToyID - An Item ID for Toys.
TradeSkillLineID - Numeric identifier for professions.
TransmogSetID - Numeric identifier for Transmogrification Sets.
UI escape sequences - UI text elements for textures and clickable chat links.
WeaponEnchantID - Numeric identifier for weapon enchants.

Mixins

SpellMixin - Interface for spell objects
ItemMixin - Interface for item objects
ItemLocationMixin - Interface for item location objects
PlayerLocationMixin - Interface for player objects
ColorMixin - Interface for color objects
FramePoolMixin - Interface for frame pools
FramePoolCollectionMixin - Interface for frame pool collections
RectangleMixin - Interface for rectangles
Vector2DMixin - Interface for 2D vectors
Vector3DMixin - Interface for 3D vectors
DoublyLinkedListMixin - Interface for doubly linked lists


Category:API types has the full list. (Though if something there is not available here: please list it!)