Apep

Roster

roster

This fake unit retrieves the list of units in the roster.

Returns TABLE

  • Returns a table indexed by GUID, containing the friendly units.

Examples:

-- DSL Mode
{ACTION, ACTION, "roster"},

-- Lua Mode
local roster = Object("roster") or {}
for _,Obj in pairs(roster) do
    -- Do something with the object
    print( Obj:Distance() )
end

lowest

This fakeunit retrieves the lowest health unit in the roster, optionally filtered by role.

Parameters

  • STRING(Optional): The role to filter by.

Returns guid/key

  • Returns the lowest health roster.

Examples:

-- DSL Mode
{ACTION, ACTION, "lowest"},

-- Lua Mode
local lowest = Object("lowest")
if lowest then
    -- Do something with the lowest object
    print( lowest.name )
end

lowestRange

This fakeunit retrieves the lowest health unit in the roster within a specified range.

Parameters

  • NUMBER: The maximum range to consider for the units.

Returns guid/key

  • Returns the lowest health roster within a specified range.

Examples:

-- DSL Mode
{ACTION, ACTION, "lowestRange(20)"},

-- Lua Mode
local lowest20 = Object("lowestRange(20)")
if lowest20 then
    -- Do something with the lowest20 object
    print( lowest20.name )
end

lowestPet

This fakeunit retrieves the lowest health non-player unit (pet) in the roster.

Returns guid/key

  • Returns the lowest unit (pet) in the roster.

Examples:

-- DSL Mode
{ACTION, ACTION, "lowestPet"},

-- Lua Mode
local lowestPet = Object("lowestPet")
if lowestPet then
    -- Do something with the lowestPet object
    print( lowestPet.name )
end

lowestpredicted | lowestp

This fakeunit retrieves the lowest predicted health unit in the roster, optionally filtered by role.

Parameters

  • STRING(Optional): The role to filter by.

Returns guid/key

  • Returns the lowest predicted health roster.

Examples:

-- DSL Mode
{ACTION, ACTION, "lowestp"},

-- Lua Mode
local lowestp = Object("lowestp")
if lowestp then
    -- Do something with the lowestp object
    print( lowestp.name )
end

lowestbuff | lbuff

This fakeunit retrieves the lowest health unit in the roster who has a specific buff, optionally filtered by role.

Parameters

  • STRING: The name of the buff to check for.
  • STRING(Optional): The role to filter by.

Returns guid/key

  • Returns the lowest health roster who has the specific buff.

Examples:

-- DSL Mode
{ACTION, ACTION, "lbuff(Rejuvenation)"},

-- Lua Mode
local lbuff = Object("lbuff(Rejuvenation)")
if lbuff then
    -- Do something with the lbuff object
    print( lbuff.name )
end

lowestnotbuff | lnbuff

This fakeunit retrieves the lowest health unit in the roster who does not have a specific buff, optionally filtered by role.

Parameters

  • STRING: The name of the buff to check for absence.
  • STRING(Optional): The role to filter by.

Returns guid/key

  • Returns the lowest health roster who does not have the specific buff.

Examples:

-- DSL Mode
{ACTION, ACTION, "lnbuff(Rejuvenation)"},

-- Lua Mode
local lnbuff = Object("lnbuff(Rejuvenation)")
if lnbuff then
    -- Do something with the lnbuff object
    print( lnbuff.name )
end

lowestdebuff | ldebuff

This fakeunit retrieves the lowest health unit in the roster who has a specific debuff, optionally filtered by role.

Parameters

  • STRING: The name of the debuff to check for.
  • STRING(Optional): The role to filter by.

Returns guid/key

  • Returns the lowest health roster who has the specific debuff.

Examples:

-- DSL Mode
{ACTION, ACTION, "ldebuff(Corruption)"},

-- Lua Mode
local ldebuff = Object("ldebuff(Corruption)")
if ldebuff then
    -- Do something with the ldebuff object
    print( ldebuff.name )
end

lowestnotdebuff | lndebuff

This fakeunit retrieves the lowest health unit in the roster who does not have a specific debuff, optionally filtered by role.

Parameters

  • STRING: The name of the debuff to check for absence.
  • STRING(Optional): The role to filter by.

Returns guid/key

  • Returns the lowest health roster who does not have the specific debuff.

Examples:

-- DSL Mode
{ACTION, ACTION, "lndebuff(Corruption)"},

-- Lua Mode
local lndebuff = Object("lndebuff(Corruption)")
if lndebuff then
    -- Do something with the lndebuff object
    print( lndebuff.name )
end

lowestDebuffType | ldebufft

This fakeunit retrieves the lowest health unit in the roster who has a specific debuff type.

Parameters

  • STRING: The name of the debuff type to check for.

Returns guid/key

  • Returns the lowest health roster who has the specific debuff type.

Examples:

-- DSL Mode
{ACTION, ACTION, "ldebufft(Magic)"},

-- Lua Mode
local ldebufft = Object("ldebufft(Magic)")
if ldebufft then
    -- Do something with the ldebufft object
    print( ldebufft.name )
end

tank

This fakeunit retrieves the tank in the roster based on a priority calculated using the maximum health and role multiplier.

Returns guid/key

  • Returns the tank roster.

Examples:

-- DSL Mode
{ACTION, ACTION, "tank1"},
{ACTION, ACTION, "tank2"},

-- Lua Mode
local tank1 = Object("tank1")
local tank2 = Object("tank2")
if tank1 then
    -- Do something with the tank1 object
    print( tank1.name )
end
if tank2 then
    -- Do something with the tank2 object
    print( tank2.name )
end

healer

This fakeunit retrieves the healer in the roster based on a priority calculated using the current health.

Returns guid/key

  • Returns the healer roster.

Examples:

-- DSL Mode
{ACTION, ACTION, "healer"},

-- Lua Mode
local healer = Object("healer")
if healer then
    -- Do something with the healer object
    print( healer.name )
end

damager

This fakeunit retrieves the damager in the roster based on a priority calculated using the current health.

Returns guid/key

  • Returns the damager roster.

Examples:

-- DSL Mode
{ACTION, ACTION, "damager"},

-- Lua Mode
local damager = Object("damager")
if damager then
    -- Do something with the damager object
    print( damager.name )
end

mostTargetedRoster

This fakeunit retrieves the unit in the roster that is most targeted by enemies.

Returns guid/key

  • Returns the most targeted unit.

Examples:

-- DSL Mode
{ACTION, ACTION, "mostTargetedRoster"},

-- Lua Mode
local mostT = Object("mostTargetedRoster")
if mostT then
    -- Do something with the mostT object
    print( mostT.name )
end

heal_dist_radius_min_avghp

This fake unit finds the unit in the roster with the highest number of nearby allies within a certain distance radius and an average health percentage below a specified threshold.

Parameters

  • NUMBER: The distance to check for.
  • NUMBER: The radius to check for.
  • NUMBER: The minimum group size.
  • NUMBER: The average health in % to check for.
  • NUMBER(optional, default: 100): The individual health threshold for players to be considered for healing.

Returns guid/key

  • The unit with the most nearby members and whose average health is the lowest percentage.

Examples:

-- DSL Mode
{ACTION, CONDITIONS, "heal_dist_radius_min_avghp(40, 10, 4, 60, 90)"},
-- {ACTION, CONDITIONS, "heal_dist_radius_min_avghp(40, 10, 4, 60)"}, --Assumes threshold of 100

-- Lua Mode
local member = Object("heal_dist_radius_min_avghp(40, 10, 4, 60, 90)")
-- local member = Object("heal_dist_radius_min_avghp(40, 10, 4, 60)") --Assumes threshold of 100
if member then
    -- Do something with the member object
    print( member.name )
end