WoW API: User defined functions

From AddOn Studio
Revision as of 03:43, 28 July 2007 by WoWWiki>Sky2042
Jump to navigation Jump to search

WoW APITemplate:Breadcrumb

These are cut-and-paste functions that you can use in your addons, submitted by WoWWiki contributors.

Arguments & Returns

setArgs(myTable, "name", ...) - remember list of arguments to use for a callback
getArgs(myTable, "name", ...) - retreive stored list of arguments, plus optional extras
GetReturnValues(order, functionCall) - Get the return values from functionCall in any order you want.

Color Functions

ColorGradient(perc, R1, G1, B1, R2, G2, B2[, ...]) - Converts a percent value into a gradient from 2 or more RGB values
HexToRGB("string") - Converts a hex color string to RGB values (0-255)
HexToRGBPerc("string") - Converts a hex color string to RGB values (0.0-1.0)
RGBToHex(red, green, blue) - Converts a RGB value (0-255) into a hex string
RGBPercToHex(red, green, blue) - Converts a RGB value (0.0-1.0) into a hex string

Frame Functions

Frame:SetManyAttributes(...) - Simple function to embed in a frame to set many atributes at once.

Item Functions

EquipItemByLink(link) - Equips the first matching item found in the player's bags.

Localization Tables

LocalizedClassNames - Table of localized classes

Metatables

Memorizing table - A special table that calculates values as needed and saves them into itself

String Functions

GetWords("string")   - Split words on space boundary, return table
strfindt(tabCaptures, ...)   - Wrapper for strfind() that returns captures in a table - can be used in if() clauses!
StringHash("string")   - Create a fair-quality 32-bit hash of a string
printMSG("string")   - Displays a custom message to the default chat frame, for the user to see (time, code and size saver).

Table Functions

EraseTable(t) - Erase all values from a table
tinsertbeforeval(tab, valBefore, val)   - Insert one value before another (without knowing its index)
tremovebyval(tab, val)   - Remove a value (without knowing its index)
tcount(tab)   - Count table members (works on non-integer-indexed tables)
tcopy(tabTo, tabFrom)   - Recursively copy contents of one table to another

Time Functions

GameTime:Get()   - Get server time including seconds and milliseconds

See also