View source for API:GetUpdatedTargets

{{LuaApi|group=Target}}
Returns information about the player's hostile, friendly and mouse-over targets.

<pre>
targets = GetUpdatedTargets()
</pre>

== Arguments ==
None.

== Returns ==
;targets : <code>table</code> – Table keyed by target slot name. Nothing is returned if no target slot has an update.

The keys are:
* <code>"selfhostiletarget"</code> – the player's hostile target.
* <code>"selffriendlytarget"</code> – the player's friendly target.
* <code>"mouseovertarget"</code> – the object under the mouse.

Each value is a target table with these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>entityid</code> || <code>number</code> || Object id of the target. 0 when the slot is empty.
|-
| <code>name</code> || <code>wstring</code> || Name of the target. <code>L""</code> when the slot is empty.
|-
| <code>healthPercent</code> || <code>number</code> || Health percentage.
|-
| <code>type</code> || <code>number</code> || Object type. The stock UI compares it with <code>SystemData.TargetObjectType</code> values.
|-
| <code>level</code> || <code>number</code> || Level.
|-
| <code>battleLevel</code> || <code>number</code> || Battle (bolstered) level. For players, equal to <code>level</code> when there is no separate battle level.
|-
| <code>tier</code> || <code>number</code> || –
|-
| <code>conType</code> || <code>number</code> || –
|-
| <code>isPvP</code> || <code>boolean</code> || –
|-
| <code>isNPC</code> || <code>boolean</code> || –
|-
| <code>mapPinType</code> || <code>number</code> || –
|-
| <code>difficultyMask</code> || <code>number</code> || –
|-
| <code>career</code> || <code>number</code> || Career line of a player target. The stock UI reads it with <code>TargetInfo:UnitCareer</code>.
|-
| <code>careerName</code> || <code>wstring</code> || Career name of a player target.
|-
| <code>npcTitle</code> || <code>wstring</code> || Title of an NPC target, from the <code>NPCTitles</code> string table. <code>L""</code> otherwise.
|-
| <code>showHealthBar</code> || <code>boolean</code> || –
|-
| <code>sigilEntryId</code> || <code>number</code> || –
|-
| <code>relationshipColor</code> || <code>table</code> || Table with <code>r</code>, <code>g</code> and <code>b</code> (<code>number</code>, 0–255).
|}

== Details ==
* The client keeps four target slots; three of them are reported. A slot is only included when the client has an update for it.
* When a target slot is empty, its table is still built, with <code>entityid</code> 0 and an empty <code>name</code>. The stock UI tests <code>name ~= L""</code> to see whether a target exists.
* If no slot has an update, nothing is returned. The stock <code>TargetInfo:UpdateFromClient</code> then clears all its cached units.
* If there is no player object, or the Lua state is not available, the function returns nothing.
* A comment in <code>easystem_targetinfo/source/targetinfo.lua</code> says the function returns no data until the next <code>PLAYER_TARGET_UPDATED</code> event.

== Errors ==
None.

== Example ==
From <code>easystem_targetinfo/source/targetinfo.lua</code>:
<pre>
function TargetInfo:UpdateFromClient ()
    local targets = GetUpdatedTargets ()

    if (targets ~= nil) then
        for unitId, targetData in pairs (targets) do
            self:SetUnitInfo (unitId, targetData)
        end
    else
        self:ClearUnits ()
    end
end
</pre>

== See also ==
* [[API:ClearTarget|ClearTarget]]
* [[API:GetTargetStatesData|GetTargetStatesData]]
* [[API:GetBuffs|GetBuffs]]