LibDogTag-3.0

From WowAce Wiki

Jump to: navigation, search
Summary
Lib: DogTag-3.0
A library to provide a markup syntax
TOC 2.4 (20400)
Category Libraries
Author ckknight
Details
Version 1.0
Links
Betas Ace SVN Zip
Changelog FishEye
API Documentation

To access documentation in-game, type /dog

Contents

Syntax

LibDogTag-3.0 works by allowing normal text with interspersed tags wrapped in brackets, e.g. "Hello [Tag] There".

Syntax is in the standard form alpha [Tag] bravo where alpha is a literal word, bravo is a literal word and [Tag] will be replaced by the associated dynamic text. All tags and modifiers are case-insensitive, but will be corrected to proper casing if the tags are legal.

Modifiers can change how a tag's output looks. For example, the :Hide(0) modifier will hide the result if it is equal to the number 0, so [HP:Hide(0)] will show the current health except when it's equal to 0, at which point it will be blank. You can chain together multiple modifiers as well, e.g. [MissingHP:Hide(0):Red] will show the missing health as red and not show it if it's equal to 0.

Tags can also take an argument, and can be fed in in a syntax similar to [Tag(argument)] or [Tag:Modifier(argument)].

Modifiers are actually syntactic sugar for tags. [HP:Hide(0)] is exactly the same as [Hide(HP, 0)]. All modifiers work this way and all tags can be used as modifiers if they accept an argument.

You can specify arguments out of order by name Using the syntax [HP(unit='player')]. This is exactly equal to [HP('player')] and ['player':HP].

Strings require either double or single quotes and are used like ["Hello" ' There'].

Logic Branching (if statements)

  • The & or and operators function as boolean AND. e.g. [Alpha and Bravo] will check if Alpha is non-false, if so, run Bravo.
  • The | or or operators function as boolean OR. e.g. [Alpha or Bravo] will check if Alpha is false, if so, run Bravo, otherwise just show Alpha.
  • The ? operator functions as an if statement. It can be used in conjunction with ! to create an if-else statement. e.g. [IsPlayer ? "Player"] or [IsPlayer ? "Player" ! "NPC"].
  • The if operator functions as an if statement. It can be used in conjunction with else to create an if-else statement. e.g. [if IsPlayer then "Player"] or [if IsPlayer then "Player" else "NPC"].
  • The not operator turns a false value into true and true value into false. e.g. [not IsPlayer]

Unit specification

Units are typically pre-specified by the addon which uses DogTag, whether "player", "mouseover", or otherwise. You can override the unit a specific tag or modifier operates on by using the form [Tag(unit="myunit")] or [Tag:Modifier(unit="myunit")]. e.g. [HP(unit='player')] gets the player's health.

List of Example units

player 
your character
target 
your target
targettarget 
your target's target
pet 
your pet
mouseover 
the unit you are currently hovering over
mouseovertarget 
the target of the unit you are currently hovering over
focus 
your focus unit
party1 
the first member of your party
partypet2 
the pet of the second member of your party
raid3 
the third member of your raid
raidpet4 
the pet of the fourth member of your raid

Tags

NameOfTheTag(argument, other=default) Note: you don't need to specify arguments if they have defaults
Description of the tag
Example of how the tag can be used.

Abbreviations

ShortClass(value=undef, unit="player")
Return a shortened class of unit, or shorten a class name
[ShortClass] => "Pr"; ["Priest":ShortClass] => "Pr"; ["Hello":ShortClass] => ""
ShortClassification(value=undef, unit="player")
Return a shortened classification of unit, or shorten a classification
[ShortClassification] => "+"; ["Boss":ShortClassification] => "b"; ["Hello":ShortClassification] => ""
ShortDruidForm(value=undef, unit="player")
Return a shortened druid form of unit, or shorten a druid form
[ShortDruidForm] => "Be", ["Bear":ShortDruidForm] => "Be"; ["Hello":ShortDruidForm] => ""
ShortRace(value=undef, unit="player")
Return a shortened race of unit, or shorten a race
[ShortRace] => "BE"; ["Blood Elf":ShortRace] => "BE"; ["Hello":ShortRace] => ""
ShortSex(value=undef, unit="player")
Return a shortened sex of the unit, or shorten a sex
[ShortSex] => "m"; ["Male":ShortSex] => "m"; ["Hello":ShortSex] => ""

Auras

AuraDuration(aura, unit="player")
Return the duration until the aura for unit is finished
[AuraDuration("Renew")] => "10.135123"
DruidForm(unit="player")
Return the shapeshift form the unit is in if unit is a druid
[DruidForm] => "Bear"; [DruidForm] => "Cat"; [DruidForm] => ""
HasAura(aura, unit="player")
Return True if unit has the aura argument
[HasAura("Shadowform")] => "True"; [HasAura("Shadowform")] => ""
HasCurseDebuff(unit="player")
Return True if the unit has a Curse debuff
[HasCurseDebuff] => "True"; [HasCurseDebuff] => ""
HasDebuffType(type, unit="player")
Return True if friendly unit is has a debuff of type
[HasDebuffType(Poison)] => "True"; [HasDebuffType(Poison)] => ""
HasDiseaseDebuff(unit="player")
Return True if the unit has a Disease debuff
[HasDiseaseDebuff] => "True"; [HasDiseaseDebuff] => ""
HasDivineIntervention(unit="player")
Return True if the unit has the Divine Intervention buff
[HasDivineIntervention] => "True"; [HasDivineIntervention] => ""
HasIceBlock(unit="player")
Return True if the unit has the Ice Block buff
[HasIceBlock] => "True"; [HasIceBlock] => ""
HasInvisibility(unit="player")
Return True if the unit has the Invisibility buff
[HasInvisibility] => "True"; [HasInvisibility] => ""
HasLastStand(unit="player")
Return True if the unit has the Last Stand buff
[HasLastStand] => "True"; [HasLastStand] => ""
HasMagicDebuff(unit="player")
Return True if the unit has a Magic debuff
[HasMagicDebuff] => "True"; [HasMagicDebuff] => ""
HasMisdirection(unit="player")
Return True if the unit has the Misdirection buff
[HasMisdirection] => "True"; [HasMisdirection] => ""
HasPoisonDebuff(unit="player")
Return True if the unit has a Poison debuff
[HasPoisonDebuff] => "True"; [HasPoisonDebuff] => ""
HasShieldWall(unit="player")
Return True if the unit has the Shield Wall buff
[HasShieldWall] => "True"; [HasShieldWall] => ""
HasSoulstone(unit="player")
Return True if the unit has the Soulstone buff
[HasSoulstone] => "True"; [HasSoulstone] => ""
IsShadowform(unit="player")
Return True if the unit has the shadowform buff
[IsShadowform] => "True"; [IsShadowform] => ""
IsStealthed(unit="player")
Return True if the unit is stealthed in some way
[IsStealthed] => "True"; [IsStealthed] => ""
NumAura(aura, unit="player")
Return the number of auras on the unit
[NumAura("Shadowform")] => "True"; [NumAura("Shadowform")] => ""
NumDebuffs(unit="player")
Return the total number of debuffs that unit has
[NumDebuffs] => "5"; [NumDebuffs] => "40"

Casting

CastDelay(unit="player")
Return the number of seconds the current cast has been delayed by interruption
[CastDelay] => "1.49997"; [CastDelay:Round(1)] => "1.5"
CastEndDuration(unit="player")
Return the duration until the current cast is meant to finish
[CastEndDuration] => "2.07151"; [CastEndDuration:FormatDuration] => "0:02"
CastIsChanneling(unit="player")
Return True if the current cast is a channeling spell
[CastIsChanneling] => "True"; [CastIsChanneling] => ""
CastName(unit="player")
Return the current or last spell to be cast
[CastName] => "Holy Light"
CastRank(unit="player")
Return the current cast rank
[CastRank] => "4"; [CastRank:Romanize] => "IV"
CastStartDuration(unit="player")
Return the duration since the current cast started
[CastStartDuration] => "3.012367"; [CastStartDuration:FormatDuration] => "0:03"
CastStopDuration(unit="player")
Return the duration which the current cast has been stopped, blank if not stopped yet
[CastStopDuration] => "2.06467"; [CastStopDuration:FormatDuration] => "0:02"; [CastStopDuration] => ""
CastStopMessage(unit="player")
Return the message as to why the cast stopped, if there is an error
[CastStopMessage] => "Failed"; [CastStopMessage] => "Interrupted", [CastStopMessage] => ""
CastTarget(unit="player")
Return the current cast target name
[CastTarget] => "Me"

Characteristics

AggroColor(value=undef, unit="player")
Return the color or wrap value with the aggression color of unit
["Hello":AggroColor] => "|cffffff00Hello|r"; [AggroColor "Hello"] => "|cffffff00Hello"
CanAttack(unit="player")
Return True if unit can be attacked
[CanAttack] => "True"; [CanAttack] => ""
Class(unit="player")
Return the class of unit
[Class] => "Hunter"
ClassColor(value=undef, unit="player")
Return the color or wrap value with the class color of unit
["Hello":ClassColor] => "|cfff58cbdHello|r"; [ClassColor "Hello"] => "|cfff58cbdHello"
Classification(unit="player")
Return the classification of unit
[Classification] => "Elite"; [Classification] => "Boss"; [Classification] => ""
Creature(unit="player")
Return the creature family or type of unit
[Creature] => "Cat"; [Creature] => "Humanoid"
CreatureType(unit="player")
Return the creature type of unit
[CreatureType] => "Beast"; [CreatureType] => "Humanoid"
DifficultyColor(value=undef, unit="player")
Return the color or wrap value with the difficulty color of unit's level compared to your own level
["Hello":DifficultyColor] => "|cffff7f00Hello|r"; [DifficultyColor "Hello"] => "|cffff7f00Hello"
Exists(unit="player")
Return True if unit exists
[Exists] => "True"; [Exists] => ""
Faction(unit="player")
Return the faction of unit
[Faction] => "Alliance"; [Faction] => "Aldor"
Guid(unit="player")
Return the GUID for the unit, an internal identifier.
[Guid] => "0x000000000ff0ad00"
Guild(unit="player")
Return the guild name or title of unit
[Guild] => "My Little Pwnies"; [Guild] => "Banker"; [Guild] => "Grommash's Pet"
GuildNote(unit="player")
Return the guild note of unit, if unit is in your guild
[GuildNote] => "My note"
GuildRank(unit="player")
Return the guild rank of unit
[GuildRank] => "Guild Leader"; [GuildRank] => "Initiate"
HostileColor(value=undef, unit="player")
Return the color or wrap value with the hostility color of unit
["Hello":HostileColor] => "|cffff0000Hello|r"; [HostileColor "Hello"] => "|cffff0000Hello"
IsEnemy(unit="player")
Return True if unit is an enemy
[IsEnemy] => "True"; [IsEnemy] => ""
IsFriend(unit="player")
Return True if unit is a friend
[IsFriend] => "True"; [IsFriend] => ""
IsMaxLevel(unit="player")
Return True if the level of unit is 70
[IsMaxLevel] => ""
IsPet(unit="player")
Return True if unit is a player's pet
[IsPet] => "True"; [IsPet] => ""
IsPlayer(unit="player")
Return True if unit is a player
[IsPlayer] => "True"; [IsPlayer] => ""
IsPlayerOrPet(unit="player")
Return True if unit is a player or a player's pet
[IsPlayerOrPet] => "True"; [IsPlayerOrPet] => ""
Level(unit="player")
Return the level of unit
[Level] => "10"; [Level] => "??"
Name(unit="player")
Return the name of unit
[Name] => "Me"
NameRealm(unit="player")
Return the name of unit, appending unit's realm if different from yours
[NameRealm] => "Me-My Realm"
OfficerNote(unit="player")
Return the officer's guild note of unit, if unit is in your guild and you are an officer
[OfficerNote] => "Special note"
Owner(unit="player")
Return the name of the owner of unit, if a pet
[Owner] => "Grommash"
PvPRank(value=undef, unit="player")
Return the PvP rank or wrap the PvP rank of unit around value
[PvPRank] => "Warlord"; [NameRealm:PvPRank] => "Warlord Me-My Realm"
Race(unit="player")
Return the race of unit
[Race] => "Tauren"
Realm(unit="player")
Return the realm of unit if not your own realm
[Realm] => "My Realm"
Sex(unit="player")
Return Male, Female, or blank depending on unit
[Sex] => "Male"; [Sex] => "Female"; [Sex] => ""
SmartRace(unit="player")
Return the race if unit is a player, otherwise the creature family
[SmartRace] => "Tauren"; [SmartRace] => "Humanoid"
TalentSpec(unit="player")
Return the talent spec of unit if available
[TalentSpec] => "30/31/0"
TalentTree(unit="player")
Return the talent tree of unit if available
[TalentTree] => "Holy/Prot"

Druid

DruidMP
Return the current mana of unit if unit is you and you are a druid
[DruidMP] => "63"
FractionalDruidMP
Return the current and maximum mana of unit if unit is you and you are a druid
[FractionalDruidMP] => "63/100"
IsMaxDruidMP
Return True if at max mana, unit is you, and you are a druid
[IsMaxDruidMP] => "True"; [IsMaxDruidMP] => ""
MaxDruidMP
Return the maximum mana of unit if unit is you and you are a druid
[MaxDruidMP] => "100"
MissingDruidMP
Return the missing mana of unit if unit is you and you are a druid
[MissingDruidMP] => "36"
PercentDruidMP
Return the percentage mana of unit if unit is you and you are a druid
[PercentDruidMP] => "63.2"; [PercentDruidMP:Percent] => "63.2%"

Experience

FractionalXP(unit="player")
Return the current and maximum experience of unit
[FractionalXP] => "8540/10000"
MaxXP(unit="player")
Return the current experience of unit
[MaxXP] => "10000"
MissingXP(unit="player")
Return the missing experience of unit
[MissingXP] => "1460"
PercentRestXP(unit="player")
Return the percentage accumulated rest experience of unit
[PercentRestXP] => "50"; [PercentRestXP:Percent] => "50%"
PercentXP(unit="player")
Return the percentage experience of unit
[PercentXP] => "85.4"; [PercentXP:Percent] => "85.4%"
RestXP(unit="player")
Return the accumulated rest experience of unit
[RestXP] => "5000"
XP(unit="player")
Return the current experience of unit
[XP] => "8540"

Health

FractionalHP(unit="player", known=false)
Return the current health and maximum health of unit, will use MobHealth if found
[FractionalHP] => "1516/2000"
HP(unit="player", known=false)
Return the current health of unit, will use MobHealth if found
[HP] => "1516"
HPColor(value=undef, unit="player")
Return the color or wrap value with the health color of unit
[Text(Hello):HPColor] => "|cffff7f00Hello|r"; [Text([HPColor]Hello)] => "|cffff7f00Hello"
IsMaxHP(unit="player")
Return True if unit is at full health
[IsMaxHP] => "True"; [IsMaxHP] => ""
MaxHP(unit="player", known=false)
Return the maximum health of unit, will use MobHealth if found
[MaxHP] => "2000"
MissingHP(unit="player", known=false)
Return the missing health of unit, will use MobHealth if found
[MissingHP] => "484"
PercentHP(unit="player")
Return the percentage health of unit
[PercentHP] => "75.8"; [PercentHP:Percent] => "75.8%"

Mathematics

Abs(number)
Take the absolute value of number
[5:Abs] => "5"; [-5:Abs] => "5"; [Abs(5)] => "5"; [Abs(-5)] => "5"
Ceil(number)
Take the ceiling of number
[1.234:Ceil] => "2"; [Ceil(1.234)] => "2"
Cos(radian)
Return the cosine of radian
[0:Cos] => "1"; [(Pi/4):Cos] => "0.70710678118655"; [Cos(Pi/2)] => "0"
Deg(radian)
Convert radian into degrees
[0:Deg] => "0"; [Pi:Deg] => "180"; [Deg(Pi/2)] => "90"
E
Return the mathematical number e, or 2.718281828459
[E] => "2.718281828459"
Floor(number)
Take the floor of number
[9.876:Floor] => "9"; [Floor(9.876)] => "9"
Ln(number)
Return the natural log of number
[1:Ln] => "0"; [E:Ln] => "1"; [Ln(E^2)] => "2"
Log(number)
Return the log base 10 of number
[1:Log] => "0"; [10:Log] => "1"; [Log(100)] => "2"
Max(number, ...)
...'...'...'...'...'...'...'...'...'...'...'...'...'...'...'...
[1:Max(2)] => "2"; [Max(3, 2, 1)] => "3"
Min(number, ...)
...'...'...'...'...'...'...'...'...'...'...'...'...'...'...'...
[1:Min(2)] => "1"; [Min(3, 2, 1)] => "1"
Pi
Return the mathematical number π, or 3.1415926535898
[Pi] => "3.1415926535898"
Rad(degree)
Convert degree into radians
[0:Rad] => "0"; [180:Rad] => "3.1415926535898"; [Rad(90)] => "1.5707963267949"
Round(number, digits=0)
Round number to the one's place or the place specified by digits
[1234.5:Round] => "1234"; [1234:Round(-2)] => "1200"; [Round(1235.5)] => "1236"; [Round(1234, -2)] => "1200"
Sign(number)
Take the signum of number
[5:Sign] => "1"; [-5:Sign] => "-1"; [0:Sign] => "0"; [Sign(5)] => "1"
Sin(radian)
Return the sin of radian
[0:Sin] => "0"; [(Pi/4):Sin] => "0.70710678118655"; [Sin(Pi/2)] => "1"

Miscellaneous

Alpha(number)
Set the transparency of the FontString according to argument
[Alpha(1)] => "Bright"; [Alpha(0)] => "Dim"
Alt
Return True if the Alt key is held down
[Alt] => "True"; [Alt] => ""
Blue(value=undef)
Return the color or wrap value with Blue color
["Hello":Blue] => "|cff0000ffHello|r"; [Blue "Hello"] => "|cff0000ffHello"
Boolean(value)
Return True if non-blank
[Boolean("Hello")] => "True"; [Boolean(nil)] => ""
Color(value=undef, red=false, green=false, blue=false)
Return the color or wrap value with the rrggbb color of argument
["Hello":Color("00ff00")] => "|cff00ff00Hello|r"; ["Hello":Color(0, 1, 0)] => "|cff00ff00Hello|r"
ComboSymbols(symbol="@")
Return @ or argument repeated by the number of combo points you have
[ComboSymbols] => "@@@@@"; [ComboSymbols(X)] => "XXX"
Combos
Return the number of combo points you have
[Combos] => "5"
Contains(left, right)
Return left if left contains right
["Hello":Contains("There")] => ""; ["Hello"]:Contains("ello") => "Hello"
Ctrl
Return True if the Ctrl key is held down
[Ctrl] => "True"; [Ctrl] => ""
CurrentTime
Return the current time in seconds, specified by WoW's internal format
[CurrentTime] => "100000"
Cyan(value=undef)
Return the color or wrap value with Cyan color
["Hello":Cyan] => "|cff00ffffHello|r"; [Cyan "Hello"] => "|cff00ffffHello"
Format(format, ...)
...'...'...'...'...'...'...'...'...'...'...'...'...'...
["%.3f":Format(1)] => "1.000"; ["%s %s":Format("Hello", "There")] => "Hello There"
FormatDuration(number, format="c")
Return a string formatted by format. Use 'e' for extended, 'f' for full, 's' for short, 'c' for compressed.
[1000:FormatDuration] => "16:40"; [1000:FormatDuration("s")] => "16.7 Mins"; [1000:FormatDuration("f")] => "16m 40s"; [1000:FormatDuration("e")] => "16 Mins 40 Secs"
Fuchsia(value=undef)
Return the color or wrap value with Fuchsia color
["Hello":Fuchsia] => "|cffff00ffHello|r"; [Fuchsia "Hello"] => "|cffff00ffHello"
Gray(value=undef)
Return the color or wrap value with Gray color
["Hello":Gray] => "|cffafafafHello|r"; [Gray "Hello"] => "|cffafafafHello"
Green(value=undef)
Return the color or wrap value with Green color
["Hello":Green] => "|cff00ff00Hello|r"; [Green "Hello"] => "|cff00ff00Hello"
Hide(value, ...)
...'...'...'...'...'...'...'...'...'...'...'...'.....
[1:Hide(1, 2, 3)] => ""; ["Alpha":Hide("Bravo", "Charlie")] => "Alpha"
Icon(data, size=0)
Return an icon using the given path
["Interface\Buttons\WHITE8X8":Icon] => "|TInterface\Buttons\WHITE8X8:0|t"
IsIn(value, ...)
...'...'...'...'...'...'...'...'...'...'...'...'...'....
[1:IsIn(1, 2, 3)] => "1"; ["Alpha":IsIn("Bravo", "Charlie")] => ""
IsMouseOver
Return True if currently mousing over the Frame the FontString is harbored in
[IsMouseOver] => "True"; [IsMouseOver] => ""
Red(value=undef)
Return the color or wrap value with Red color
["Hello":Red] => "|cffff0000Hello|r"; [Red "Hello"] => "|cffff0000Hello"
Shift
Return True if the Shift key is held down
[Shift] => "True"; [Shift] => ""
White(value=undef)
Return the color or wrap value with White color
["Hello":White] => "|cffffffffHello|r"; [White "Hello"] => "|cffffffffHello"
Yellow(value=undef)
Return the color or wrap value with Yellow color
["Hello":Yellow] => "|cffffff00Hello|r"; [Yellow "Hello"] => "|cffffff00Hello"

Operators

left % right
Take the modulus of left and right
[5 % 3] => "2"
left * right
Multiple left and right together
[1 * 2] => "2"
left + right
Add left and right together
[1 + 2] => "3"
left - right
Subtract right from left
[1 - 2] => "-1"
left / right
Divide left by right
[1 / 2] => "0.5"
left < right
Check if left is less than right, if so, return left
[5 < 3] => ""; [3 < 5] => "3"; [3 < 3] => ""
left <= right
Check if left is less than or equal to right, if so, return left
[5 <= 3] => ""; [3 <= 5] => "3"; [3 <= 3] => "3"
left = right
Check if left is equal to right, if so, return left
[1 = 2] => ""; [1 = 1] => "1"
left > right
Check if left is greater than right, if so, return left
[5 > 3] => "5"; [3 > 5] => ""; [3 > 3] => ""
left >= right
Check if left is greater than or equal to right, if so, return left
[5 >= 3] => "5"; [3 >= 5] => ""; [3 >= 3] => "3"
left ^ right
Raise left to the right power
[5 ^ 3] => "125"
-number
Return the negative of number
[-1] => "-1"; [-(-1)] => "1"
left ~= right
Check if left is not equal to right, if so, return left
[1 ~= 2] => "1"; [1 ~= 1] => ""

Power

FractionalMP(unit="player")
Return the current and maximum mana/rage/energy of unit
[FractionalMP] => "63/100"
HasMP(unit="player")
Return True if unit has no power type at all
[HasNoMP] => "True"; [HasNoMP] => ""
IsEnergy(unit="player")
Return True if unit currently uses energy
[IsEnergy] => "True"; [IsEnergy] => ""
IsFocus(unit="player")
Return True if unit currently uses focus
[IsFocus] => "True"; [IsFocus] => ""
IsMana(unit="player")
Return True if unit currently uses mana
[IsMana] => "True"; [IsMana] => ""
IsMaxMP(unit="player")
Return True if unit is at full rage/mana/energy
[IsMaxMP] => "True"; [IsMaxMP] => ""
IsPowerType(type, unit="player")
Return True if unit currently uses the power of argument
[HasPower("Rage")] => "True"; [HasPower("Mana")] => ""
IsRage(unit="player")
Return True if unit currently uses rage
[IsRage] => "True"; [IsRage] => ""
MP(unit="player")
Return the current mana/rage/energy of unit
[MP] => "63"
MaxMP(unit="player")
Return the maximum mana/rage/energy of unit
[MaxMP] => "100"
MissingMP(unit="player")
Return the missing mana/rage/energy of unit
[MissingMP] => "36"
PercentMP(unit="player")
Return the percentage mana/rage/energy of unit
[PercentMP] => "63.2"; [PercentMP:Percent] => "63.2%"
PowerColor(value=undef, unit="player")
Return the color or wrap value with current power color of unit, whether rage, mana, or energy
["Hello":PowerColor] => "|cff3071bfHello|r"; [PowerColor "Hello"] => "|cff3071bfHello"
TypePower(unit="player")
Return whether unit currently uses Rage, Focus, Energy, or Mana
[TypePower] => "Rage"; [TypePower] => "Mana"

Range

MaxRange(unit="player")
Return the approximate maximum range of unit, if RangeCheck-1.0 is available
[MaxRange] => "15"; [MaxRange] => ""
MinRange(unit="player")
Return the approximate minimum range of unit, if RangeCheck-1.0 is available
[MinRange] => "5"; [MinRange] => ""
Range(unit="player")
Return the approximate range of unit, if RangeCheck-1.0 is available
[Range] => "5 - 15"; [Range] => "30+"; [Range] => ""

Reputation

FractionalReputation(faction=undef)
Return the current and maximum reputation of the currently watched faction or argument
[FractionalReputation] => "1234/12000"; [FractionalReputation(Exodar)] => "2345/21000"
MaxReputation(faction=undef)
Return the maximum reputation of the watched faction or specified
[MaxReputation] => "12000"; [MaxReputation(Exodar)] => "21000"
MissingReputation(faction=undef)
Return the missing reputation of the currently watched faction or argument
[MissingReputation] => "10766"; [MissingReputation(Exodar)] => "18655"
PercentReputation(faction=undef)
Return the percentage reputation of the currently watched faction or argument
[PercentReputation] => "10.3"; [PercentReputation:Percent] => "10.3%"; [PercentReputation(Exodar)] => "11.2"; [PercentReputation(Exodar):Percent] => "11.2%"
Reputation(faction=undef)
Return the current reputation of the watched faction or specified
[Reputation] => "1234"; [Reputation(Exodar)] => "2345"
ReputationColor(value=undef, faction=undef)
Return the color or wrap value with the color associated with either the currently watched faction or the given argument
["Hello":ReputationColor] => "|cff7f0000Hello|r"; ["Hello":ReputationColor(Exodar)] => "|cff007f00Hello|r"; [ReputationColor(faction=Exodar) "Hello")] => "|cff007f00Hello"
ReputationName
Return the name of the currently watched faction
[ReputationName] => "Exodar"
ReputationReaction(faction=undef)
Return your current reputation rank with the watched faction or argument
[ReputationReaction] => "Normal"; [ReputationReaction(Exodar)] => "Friendly"

Status

AFK
Return AFK and the time AFK if unit is AFK
[AFK] => "AFK (2:12)"; [AFK] => ""
AFKDuration(unit="player")
Return the duration AFK if unit is AFK
[AFKDuration] => "110"; [AFKDuration:FormatDuration] => "1:50"
DND(unit="player")
Return DND if the unit has specified DND
[DND] => "DND"; [DND] => ""
Dead(unit="player")
Return Dead or Ghost and the duration dead if unit is dead
[Dead] => "Dead (1:34)"; [Dead] => "Ghost"; [Dead] => ""
DeadDuration(unit="player")
Return the duration dead if unit is dead and time is known, unit can be dead and have an unknown time of death
[DeadDuration] => "110"; [DeadDuration:FormatDuration] => "1:50"
DeadType(unit="player")
Return Dead or Ghost if unit is dead
[DeadType] => "Dead"; [DeadType] => "Ghost"; [DeadType] => ""
FKey(unit="player")
Return the function key to press to select unit
[FKey] => "F5"
HappyColor(value=undef)
Return the color or wrap value with the color associated with your pet's happiness
[Text(Hello):HappyColor] => "|cff00ff00Hello|r"; [Text([HappyColor]Hello)] => "|cff00ff00Hello"
HappyIcon(happy="
D", content=":I", unhappy="B(")
Return an icon representative of how happy your pet is
[HappyIcon] => ":D"; [HappyIcon] => ":I"; [HappyIcon] => "B("
HappyNum
Return the happiness number of your pet
[HappyNum] => "3"
HappyText
Return a description of how happy your pet is
[HappyText] => "Happy"
InCombat(unit="player")
Return True if unit is in combat
[InCombat] => "True"; [InCombat] => ""
InGroup
Return True if you are in a party or raid
[InGroup] => "True"; [InGroup] => ""
IsCharmed(unit="player")
Return True if unit is under mind control
[IsCharmed] => "True"; [IsCharmed] => ""
IsFeignedDeath(unit="player")
Return True if unit is feigning death
[IsFeignedDeath] => ""True""; [IsFeignedDeath] => ""
IsLeader(unit="player")
Return True if unit is a party leader
[IsLeader] => "True"; [IsLeader] => ""
IsMasterLooter(unit="player")
Return True if unit is the master looter for your raid
[IsMasterLooter] => "True"; [IsMasterLooter] => ""
IsResting
Return True if you are in an inn or capital city
[IsResting] => "True"; [IsResting] => ""
IsTapped(unit="player")
Return True if unit is tapped, but not by you
[IsTapped] => "True"; [IsTapped] => ""
IsTappedByMe(unit="player")
Return True if unit is tapped by you
[IsTappedByMe] => "True"; [IsTappedByMe] => ""
IsUnit(other, unit="player")
Return True if unit is the same as argument
[IsUnit("target")] => "True"; [IsUnit("party1")] => ""
IsVisible(unit="player")
Return True if unit is in visible range
[IsVisible] => "True"; [IsVisible] => ""
NumTargeting(unit="player")
Return the number of group members currently targeting unit
[NumTargeting] => "2"
Offline
Return Offline and the time offline if unit is offline
[Offline] => "Offline (2:45)"; [Offline] => ""
OfflineDuration(unit="player")
Return the duration offline if unit is offline
[OfflineDuration] => "110"; [OfflineDuration:FormatDuration] => "1:50"
Pet(unit="player")
Return the unit id of unit's pet
[Pet] => "partypet1"; [HP(unit=Pet)] => "500"
PvP(unit="player")
Return PvP or FFA if the unit is PvP-enabled
[PvP] => "PvP"; [PvP] => "FFA"; [PvP] => ""
RaidGroup(unit="player")
Return the raid group that unit is in
[RaidGroup] => "3"
Status(unit="player")
Return whether unit is offline, has divine intervention, is dead, feigning death, or has a soulstone while dead
[Status] => "Offline"; [Status] => "Dead"; [Status] => ""
StatusColor(value=undef, unit="player")
Return the color or wrap value with the color associated with unit's current status
[Text(Hello):StatusColor] => "|cff7f7f7fHello|r"; [Text([StatusColor]Hello)] => "|cff7f7f7fHello"
Target(unit="player")
Return the unit id of unit's target
[Target] => "party1target"; [HP(unit=Target)] => "1000"
TargetingList(unit="player")
Return an alphabetized, comma-separated list of group members currently targeting unit
[TargetingList] => "Grommash, Thrall"
Zone(unit="player")
Return the zone of unit
[Zone] => "Shattrath"

Text Manipulation

Abbreviate(value)
Abbreviate value if a space is found
["Hello":Abbreviate] => "Hello"; ["Hello World":Abbreviate] => "HW"
Append(left, right=false)
Append right to left if right exists
["Hello":Append(" There")] => "Hello There"; ["Hello":Append(nil)] => "Hello"
Concatenate(...)
...'...'...'...'...'...'...'...'...'...'...'...'...'...'...'...'...'...'...'...'...
[Concatenate("Hello", " ", "World")] => "Hello World"; [Concatenate(nil, " ", World")] => ""; [Concatenate("Hello", nil)] => ""
Prepend(right, left=false)
Prepend left to right if right exists
["There":Prepend("Hello ")] => "Hello There"; ["There":Prepend(nil)] => "There"

Text manipulation

Angle(value)
Wrap value with angle brackets
["Hello":Angle] => "<Hello>"
Brace(value)
Wrap value with braces
["Hello":Brace] => "{Hello}"
Bracket(value)
Wrap value with square brackets
["Hello":Bracket] => "[Hello]"
Length(value)
Return the length of value
["Hello":Length] => "5"; ["Hi guys":Length] => "7"
Lower(value)
Turn value into an lowercase string
["Hello":Lower] => "hello"
Paren(value)
Wrap value with parentheses
["Hello":Paren] => "(Hello)"
Percent(number)
Append a percentage sign to the end of number
[50:Percent] => "50%"; [Percent(50)] => "50%"
Repeat(value, number)
Repeat value number times
["Hello":Rep(3)] => "HelloHelloHello"
Romanize(value)
Turn number_value into a roman numeral.
[1666:Romanize] => "MDCLXVI"
Short(value)
Shorten value to have at maximum 3 significant figures showing
[1234:Short] => "1.23k"; [12345678:Short] => "12.3m"; ["1234/2345":Short] => "1.23k/2.35k"
Substring(value, start, finish=-1)
Truncate value to the length specified by number, adding ellipses by default
["Hello":Truncate(3)] => "Hel..."; ["Hello":Truncate(3, nil)] => "Hel"
Truncate(value, number, ellipses=true)
Truncate value to the length specified by number, adding ellipses by default
["Hello":Truncate(3)] => "Hel..."; ["Hello":Truncate(3, nil)] => "Hel"
Upper(value)
Turn value into an uppercase string
["Hello":Upper] => "HELLO"
VeryShort(value)
Shorten value to its closest denomination
[1234:VeryShort] => "1k"; [123456:VeryShort] => "123k"; [Text(12345/23456):VeryShort] => "12k/23k"

Threat

FractionalThreat(unit="player")
Return the current and maximum threat that you have against enemy unit or that friendly unit has against your target, if ThreatLib is available
[FractionalThreat] => "50/80"
HasThreat(unit="player")
Return True if you have threat against enemy unit or friendly unit has threat against your target and if ThreatLib is available
[HasThreat] => "True"; [HasThreat] => ""
MaxThreat(unit="player")
Return the maximum threat that group members have against enemy unit or that group members have against your target, if ThreatLib is available
[MaxThreat] => "80"
MissingThreat(unit="player")
Return the missing threat that you have against enemy unit or that friendly unit has against your target, if ThreatLib is available
[MissingThreat] => "30"
PercentThreat(unit="player")
Return the percentage threat that you have against enemy unit or that friendly unit has against your target, if ThreatLib is available
[PercentThreat] => "62.5"; [PercentThreat:Percent] => "62.5%"
Threat(unit="player")
Return the current threat that you have against enemy unit or that friendly unit has against your target, if Threat-2.0 is available
[Threat] => "50"
Personal tools
Support the Site