View source for API:GetLocationsForTrophies

{{LuaApi|group=Item}}
Returns the points on the player's character where trophies can be attached.

<pre>
attachPoints = GetLocationsForTrophies()
</pre>

== Arguments ==
None.

== Returns ==
;attachPoints : <code>table</code> – Array of attachment point tables, indexed from 1. May be empty.

Each attachment point table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>trophyLocation</code> || <code>number</code> || Location id of the point. Pass it to [[API:AttachTrophyToLocation|AttachTrophyToLocation]] or [[API:RequestEquipTrophy|RequestEquipTrophy]].
|-
| <code>trophyLocIndex</code> || <code>number</code> || Index of the point within its location, starting at 1.
|-
| <code>inventorySlotNum</code> || <code>number</code> || Equipment slot the point belongs to: 10 (<code>GameData.EquipSlots.SHOULDERS</code>) or 14 (<code>GameData.EquipSlots.BELT</code>), depending on the location.
|}

== Details ==
* The list comes from the client's data for the player's character model, not from the equipped items.
* If the client cannot find that data, or there is no player object, the function returns nothing. The stock UI works around this with <code>CharacterWindow.RerequestTrophyLocData()</code>, which calls the function again when the cached value is <code>nil</code>.
* The stock UI compares <code>inventorySlotNum</code> with the <code>slots</code> array of a trophy's item data to decide whether the trophy may go there. It also adds its own <code>inUse</code> field to the tables; the client does not set it.

== Errors ==
None.

== Example ==
From <code>default/ea_characterwindow/source/characterwindowtrophies.lua</code>:
<pre>
CharacterWindow.trophyLocData = GetLocationsForTrophies()   -- provides list of available attachment points
CharacterWindow.trophyData = DataUtils.GetTrophyData()      -- provides item info for all trophy slots (may be blank data)
</pre>

Finding an attachment point, from the same file:
<pre>
for apIndex, attachPoint in pairs( CharacterWindow.trophyLocData ) do
    if attachPoint.trophyLocation == location and attachPoint.trophyLocIndex == index then
        return apIndex, attachPoint
    end
end
</pre>

== See also ==
* [[API:GetTrophyData|GetTrophyData]]
* [[API:AttachTrophyToLocation|AttachTrophyToLocation]]
* [[API:RequestEquipTrophy|RequestEquipTrophy]]