Inspect.Ability.Detail

From Riftui Wiki

Jump to: navigation, search

Returns a (table) of ability identifiers that are paired with a table of their respective information. If only a single ability identifier is passed, only the respective ability table will be returned.

Contents

Signature

detail = Inspect.Ability.Detail(list)

Parameters

list (string, table) - A single ability identifier string or a table of ability identifiers (normally obtained from Inspect.Ability.List).

-- Ability identifier table structure --
ability_list = {
       ability_identifier = true,
       ability_b_identifier = true,
       ...
}

Return Value

detail (table) - A (table) of ability identifiers that are paired with a table of their respective information. If only a single ability identifier is passed, only the respective ability table will be returned.

-- Structure of a returned table of multiple details --
ability_detail{
       ability_identifier = { name = val, ... },
       ability_b_identifier = { name = val, ...},
       ...
}

Returned Members

Member Description
autoattack Autoattack mode of the ability.
castingTime Casting time of the ability, in seconds.
channeled Signals that the ability is channeled.
continuous Signals that the ability is continuous.
cooldown Cooldown of the ability, in seconds.
costCharge The amount of charge this ability consumes on use.
costEnergy The amount of energy this ability consumes on use.
costMana The amount of mana this ability consumes on use.
costPlanarCharge The amount of planar charges this ability consumes on use.
costPower The amount of power this ability consumes on use.
currentCooldownBegin The time the current cooldown started, in the context of Inspect.Time.Frame.
currentCooldownDuration Duration of the current cooldown the ability is influenced by, in seconds.
currentCooldownExpired Number of seconds the current cooldown is past its expiration time. Generally indicates lag.
currentCooldownRemaining Time remaining in the ability's current cooldown, in seconds.
gainCharge Amount of charge gained by using the ability.
icon Resource filename of the ability's icon.
name Name of the ability.
outOfRange Signals that the ability is out of range.
passive Signals that the ability is passive.
positioned Signals that the ability's effect is manually positioned by the user.
racial Signals that the ability is a racial ability.
rangeMax The maximum range of the ability.
rangeMin The minimum range of the ability.
stealthRequired Signals that the ability requires the user to be in stealth.
target The Unit ID of the unit that this ability will be used on if triggered at this moment.
unusable Signals that this ability is unusable.
weapon The required equipped weapon for this ability. May be "any", "melee", or "ranged".

Example

local function PrintPassives()
       -- Get the current list of abilities --
       local list = Inspect.Ability.List()
       -- If the list of abilities are not available, don't proceed --
       if not list then return end
 
       -- Get detailed information on the ability list --
       local details = Inspect.Ability.Detail(list)
 
       -- Step through the table --
       for id, ability in pairs(details) do
              -- check if the ability is a passive --
              if ability.passive then
                   -- print out the ability name --
                   print(ability.name)  
              end
       end
end
Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox