Skip to content
Starlon edited this page Nov 30, 2011 · 2 revisions

Functions

<tr>
<td class="name" nowrap><a href="#PluginUnit:New">PluginUnit:New</a>&nbsp;(environment)</td>
<td class="summary">Populate an environment with this plugin's fields </td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitAFK">UnitAFK</a>&nbsp;(unit)</td>
<td class="summary">afk:	Signals that the unit is AFK.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitCalling">UnitCalling</a>&nbsp;(unit)</td>
<td class="summary">calling:	The unit's calling.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitCharge">UnitCharge</a>&nbsp;(unit)</td>
<td class="summary">charge:	The unit's charge.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitChargeMax">UnitChargeMax</a>&nbsp;(unit)</td>
<td class="summary">chargeMax: </td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitCombo">UnitCombo</a>&nbsp;(unit)</td>
<td class="summary">combo:	The unit's combo points.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitComboUnit">UnitComboUnit</a>&nbsp;(unit)</td>
<td class="summary">comboUnit:	The Unit ID of the unit that the combo points have been placed on.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitEnergy">UnitEnergy</a>&nbsp;(unit)</td>
<td class="summary">energy:	The unit's energy.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitFaction">UnitFaction</a>&nbsp;(unit)</td>
<td class="summary">factionName: The unit's faction name.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitGuaranteedLoot">UnitGuaranteedLoot</a>&nbsp;(unit)</td>
<td class="summary">guaranteedLoot:	Signals that this unit guarantees loot on death.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitGuild">UnitGuild</a>&nbsp;(unit)</td>
<td class="summary">guild:	The unit's guild.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitHealth">UnitHealth</a>&nbsp;(unit)</td>
<td class="summary">health:	The unit's health.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitHealthCap">UnitHealthCap</a>&nbsp;(unit)</td>
<td class="summary">healthCap:	The unit's capped maximum health.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitHealthMax">UnitHealthMax</a>&nbsp;(unit)</td>
<td class="summary">healthMax:	The unit's maximum health.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitLevel">UnitLevel</a>&nbsp;(unit)</td>
<td class="summary">level:	The unit's level.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitLocation">UnitLocation</a>&nbsp;(unit)</td>
<td class="summary">locationName: The name of the unit's location.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitLoot">UnitLoot</a>&nbsp;(unit)</td>
<td class="summary">loot:	The Unit ID that has looting rights to this corpse.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitMana">UnitMana</a>&nbsp;(unit)</td>
<td class="summary">mana:	The unit's mana.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitManaMax">UnitManaMax</a>&nbsp;(unit)</td>
<td class="summary">manaMax:	The unit's maximum mana.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitMark">UnitMark</a>&nbsp;(unit)</td>
<td class="summary">mark:	The mark on this unit.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitName">UnitName</a>&nbsp;(unit)</td>
<td class="summary">name:	The unit's name.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitNameSecondary">UnitNameSecondary</a>&nbsp;(unit)</td>
<td class="summary">nameSecondary:	The unit's secondary name.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitOffline">UnitOffline</a>&nbsp;(unit)</td>
<td class="summary">offline:	Signals that the unit is offline.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitPVP">UnitPVP</a>&nbsp;(unit)</td>
<td class="summary">pvp:	The unit's PvP flag.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitPlanar">UnitPlanar</a>&nbsp;(unit)</td>
<td class="summary">planar:	The unit's available planar charges.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitPlayer">UnitPlayer</a>&nbsp;(unit)</td>
<td class="summary">player:	Signals that the unit is a player, not an NPC.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitPower">UnitPower</a>&nbsp;(unit)</td>
<td class="summary">power:	The unit's power.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitPublicSize">UnitPublicSize</a>&nbsp;(unit)</td>
<td class="summary">publicSize: The unit's current public group size.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitRace">UnitRace</a>&nbsp;(unit)</td>
<td class="summary">ready:	The unit's race.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitReady">UnitReady</a>&nbsp;(unit)</td>
<td class="summary">ready:	The unit's readycheck status.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitRelation">UnitRelation</a>&nbsp;(unit)</td>
<td class="summary">relation:	The unit's relation to you.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitRelation">UnitRelation</a>&nbsp;(unit)</td>
<td class="summary">relation:	The unit's relation to you.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitRole">UnitRole</a>&nbsp;(unit)</td>
<td class="summary">role:	The unit's role.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitTag">UnitTag</a>&nbsp;(unit)</td>
<td class="summary">tagName: The unit's tags, localized.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitTagText">UnitTagText</a>&nbsp;(unit)</td>
<td class="summary">tagName: The unit's tags, localized.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitTier">UnitTier</a>&nbsp;(unit)</td>
<td class="summary">tier: </td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitTitlePrefix">UnitTitlePrefix</a>&nbsp;(unit)</td>
<td class="summary">titlePrefix:	The unit's title prefix.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitTitleSuffix">UnitTitleSuffix</a>&nbsp;(unit)</td>
<td class="summary">titleSuffix:	The unit's title suffix.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitVitality">UnitVitality</a>&nbsp;(unit)</td>
<td class="summary">vitality:	The unit's vitality.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#UnitWarfront">UnitWarfront</a>&nbsp;(unit)</td>
<td class="summary">warfront:	Signals that the unit has temporarily left the group to join a warfront.</td>
</tr>


Functions

PluginUnit:New (environment)
Populate an environment with this plugin's fields

Parameters

<li>
  environment: 
</li>

Usage:

:New(environment)

Return value:

A new plugin object, aka the environment
UnitAFK (unit)
afk: Signals that the unit is AFK. Provided only for the player and the player's groupmembers.

Parameters

<li>
  unit: 
</li>
UnitCalling (unit)
calling: The unit's calling. May be "mage", "rogue", "cleric", or "warrior".

Parameters

<li>
  unit: 
</li>
UnitCharge (unit)
charge: The unit's charge. Provided only for the player.

Parameters

<li>
  unit: 
</li>
UnitChargeMax (unit)
chargeMax:

Parameters

<li>
  unit: 
</li>
UnitCombo (unit)
combo: The unit's combo points. Provided only for the player.

Parameters

<li>
  unit: 
</li>
UnitComboUnit (unit)
comboUnit: The Unit ID of the unit that the combo points have been placed on. Provided only for the player.

Parameters

<li>
  unit: 
</li>
UnitEnergy (unit)
energy: The unit's energy.

Parameters

<li>
  unit: 
</li>
UnitFaction (unit)
factionName: The unit's faction name.

Parameters

<li>
  unit: 
</li>
UnitGuaranteedLoot (unit)
guaranteedLoot: Signals that this unit guarantees loot on death. Shown in the user interface as a diamond above the portrait.

Parameters

<li>
  unit: 
</li>
UnitGuild (unit)
guild: The unit's guild.

Parameters

<li>
  unit: 
</li>
UnitHealth (unit)
health: The unit's health.

Parameters

<li>
  unit: 
</li>
UnitHealthCap (unit)
healthCap: The unit's capped maximum health.

Parameters

<li>
  unit: 
</li>
UnitHealthMax (unit)
healthMax: The unit's maximum health.

Parameters

<li>
  unit: 
</li>
UnitLevel (unit)
level: The unit's level. May be "??" if the unit is hostile and very high-level.

Parameters

<li>
  unit: 
</li>
UnitLocation (unit)
locationName: The name of the unit's location. Provided only for friendly players.

Parameters

<li>
  unit: 
</li>
UnitLoot (unit)
loot: The Unit ID that has looting rights to this corpse.

Parameters

<li>
  unit: 
</li>
UnitMana (unit)
mana: The unit's mana.

Parameters

<li>
  unit: 
</li>
UnitManaMax (unit)
manaMax: The unit's maximum mana.

Parameters

<li>
  unit: 
</li>
UnitMark (unit)
mark: The mark on this unit.

Parameters

<li>
  unit: 
</li>
UnitName (unit)
name: The unit's name.

Parameters

<li>
  unit: 
</li>
UnitNameSecondary (unit)
nameSecondary: The unit's secondary name.

Parameters

<li>
  unit: 
</li>
UnitOffline (unit)
offline: Signals that the unit is offline. Provided only for the player's groupmembers.

Parameters

<li>
  unit: 
</li>
UnitPVP (unit)
pvp: The unit's PvP flag.

Parameters

<li>
  unit: 
</li>
UnitPlanar (unit)
planar: The unit's available planar charges. Provided only for the player.

Parameters

<li>
  unit: 
</li>
UnitPlayer (unit)
player: Signals that the unit is a player, not an NPC.

Parameters

<li>
  unit: 
</li>
UnitPower (unit)
power: The unit's power.

Parameters

<li>
  unit: 
</li>
UnitPublicSize (unit)
publicSize: The unit's current public group size. nil if the group is not public. Provided only for friendly players.

Parameters

<li>
  unit: 
</li>
UnitRace (unit)
ready: The unit's race.

Parameters

<li>
  unit: 
</li>
UnitReady (unit)
ready: The unit's readycheck status.

Parameters

<li>
  unit: 
</li>
UnitRelation (unit)
relation: The unit's relation to you. May be "hostile" or "friendly". Neutral targets will not have this member.

Parameters

<li>
  unit: 
</li>
UnitRelation (unit)
relation: The unit's relation to you. May be "hostile" or "friendly". Neutral targets will not have this member.

Parameters

<li>
  unit: 
</li>
UnitRole (unit)
role: The unit's role. May be "tank", "heal", "dps", "support", or nil. Provided only for the player and the player's groupmembers.

Parameters

<li>
  unit: 
</li>
UnitTag (unit)
tagName: The unit's tags, localized.

Parameters

<li>
  unit: 
</li>
UnitTagText (unit)
tagName: The unit's tags, localized.

Parameters

<li>
  unit: 
</li>
UnitTier (unit)
tier:

Parameters

<li>
  unit: 
</li>
UnitTitlePrefix (unit)
titlePrefix: The unit's title prefix.

Parameters

<li>
  unit: 
</li>
UnitTitleSuffix (unit)
titleSuffix: The unit's title suffix.

Parameters

<li>
  unit: 
</li>
UnitVitality (unit)
vitality: The unit's vitality. Provided only for the player.

Parameters

<li>
  unit: 
</li>
UnitWarfront (unit)
warfront: Signals that the unit has temporarily left the group to join a warfront. Provided only for groupmembers.

Parameters

<li>
  unit: 
</li>

Valid XHTML 1.0!

Clone this wiki locally