File ../../LibScriptablePlugins-1.0/LibScriptablePluginUnit-1.0/LibScriptablePluginUnit-1.0.lua

Functions

PluginUnit:New (environment) Populate an environment with this plugin's fields
UnitAFK (unit) afk: Signals that the unit is AFK.
UnitCalling (unit) calling: The unit's calling.
UnitCharge (unit) charge: The unit's charge.
UnitChargeMax (unit) chargeMax:
UnitCombo (unit) combo: The unit's combo points.
UnitComboUnit (unit) comboUnit: The Unit ID of the unit that the combo points have been placed on.
UnitEnergy (unit) energy: The unit's energy.
UnitFaction (unit) factionName: The unit's faction name.
UnitGuaranteedLoot (unit) guaranteedLoot: Signals that this unit guarantees loot on death.
UnitGuild (unit) guild: The unit's guild.
UnitHealth (unit) health: The unit's health.
UnitHealthCap (unit) healthCap: The unit's capped maximum health.
UnitHealthMax (unit) healthMax: The unit's maximum health.
UnitLevel (unit) level: The unit's level.
UnitLocation (unit) locationName: The name of the unit's location.
UnitLoot (unit) loot: The Unit ID that has looting rights to this corpse.
UnitMana (unit) mana: The unit's mana.
UnitManaMax (unit) manaMax: The unit's maximum mana.
UnitMark (unit) mark: The mark on this unit.
UnitName (unit) name: The unit's name.
UnitNameSecondary (unit) nameSecondary: The unit's secondary name.
UnitOffline (unit) offline: Signals that the unit is offline.
UnitPVP (unit) pvp: The unit's PvP flag.
UnitPlanar (unit) planar: The unit's available planar charges.
UnitPlayer (unit) player: Signals that the unit is a player, not an NPC.
UnitPower (unit) power: The unit's power.
UnitPublicSize (unit) publicSize: The unit's current public group size.
UnitRace (unit) ready: The unit's race.
UnitReady (unit) ready: The unit's readycheck status.
UnitRelation (unit) relation: The unit's relation to you.
UnitRelation (unit) relation: The unit's relation to you.
UnitRole (unit) role: The unit's role.
UnitTag (unit) tagName: The unit's tags, localized.
UnitTagText (unit) tagName: The unit's tags, localized.
UnitTier (unit) tier:
UnitTitlePrefix (unit) titlePrefix: The unit's title prefix.
UnitTitleSuffix (unit) titleSuffix: The unit's title suffix.
UnitVitality (unit) vitality: The unit's vitality.
UnitWarfront (unit) warfront: Signals that the unit has temporarily left the group to join a warfront.


Functions

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

Parameters

  • environment:

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

  • unit:
UnitCalling (unit)
calling: The unit's calling. May be "mage", "rogue", "cleric", or "warrior".

Parameters

  • unit:
UnitCharge (unit)
charge: The unit's charge. Provided only for the player.

Parameters

  • unit:
UnitChargeMax (unit)
chargeMax:

Parameters

  • unit:
UnitCombo (unit)
combo: The unit's combo points. Provided only for the player.

Parameters

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

Parameters

  • unit:
UnitEnergy (unit)
energy: The unit's energy.

Parameters

  • unit:
UnitFaction (unit)
factionName: The unit's faction name.

Parameters

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

Parameters

  • unit:
UnitGuild (unit)
guild: The unit's guild.

Parameters

  • unit:
UnitHealth (unit)
health: The unit's health.

Parameters

  • unit:
UnitHealthCap (unit)
healthCap: The unit's capped maximum health.

Parameters

  • unit:
UnitHealthMax (unit)
healthMax: The unit's maximum health.

Parameters

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

Parameters

  • unit:
UnitLocation (unit)
locationName: The name of the unit's location. Provided only for friendly players.

Parameters

  • unit:
UnitLoot (unit)
loot: The Unit ID that has looting rights to this corpse.

Parameters

  • unit:
UnitMana (unit)
mana: The unit's mana.

Parameters

  • unit:
UnitManaMax (unit)
manaMax: The unit's maximum mana.

Parameters

  • unit:
UnitMark (unit)
mark: The mark on this unit.

Parameters

  • unit:
UnitName (unit)
name: The unit's name.

Parameters

  • unit:
UnitNameSecondary (unit)
nameSecondary: The unit's secondary name.

Parameters

  • unit:
UnitOffline (unit)
offline: Signals that the unit is offline. Provided only for the player's groupmembers.

Parameters

  • unit:
UnitPVP (unit)
pvp: The unit's PvP flag.

Parameters

  • unit:
UnitPlanar (unit)
planar: The unit's available planar charges. Provided only for the player.

Parameters

  • unit:
UnitPlayer (unit)
player: Signals that the unit is a player, not an NPC.

Parameters

  • unit:
UnitPower (unit)
power: The unit's power.

Parameters

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

Parameters

  • unit:
UnitRace (unit)
ready: The unit's race.

Parameters

  • unit:
UnitReady (unit)
ready: The unit's readycheck status.

Parameters

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

Parameters

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

Parameters

  • unit:
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

  • unit:
UnitTag (unit)
tagName: The unit's tags, localized.

Parameters

  • unit:
UnitTagText (unit)
tagName: The unit's tags, localized.

Parameters

  • unit:
UnitTier (unit)
tier:

Parameters

  • unit:
UnitTitlePrefix (unit)
titlePrefix: The unit's title prefix.

Parameters

  • unit:
UnitTitleSuffix (unit)
titleSuffix: The unit's title suffix.

Parameters

  • unit:
UnitVitality (unit)
vitality: The unit's vitality. Provided only for the player.

Parameters

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

Parameters

  • unit:

Valid XHTML 1.0!