View source for API:RequestItemSet

{{LuaApi|group=Item}}
Publishes the client's cached data for an item set to <code>GameData.UpdatedItemSet</code> and raises <code>ITEM_SET_DATA_ARRIVED</code>.

<pre>
RequestItemSet(itemSetId)
</pre>

== Arguments ==
;itemSetId : <code>number</code> – ID of the item set. Must not be 0.

== Returns ==
Nothing useful. See Details.

== Details ==
* If the client has data for this set, it is written to <code>GameData.UpdatedItemSet</code> and <code>SystemData.Events.ITEM_SET_DATA_ARRIVED</code> is raised. The fields written are:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || number || Item set ID.
|-
| <code>name</code> || wstring || Name of the set.
|-
| <code>castingLevel</code> || number || The set's casting level value.
|-
| <code>itemNames[1]</code> … <code>itemNames[21]</code> || wstring || Names of the set's pieces. Unused entries are empty.
|-
| <code>bonuses[1]</code> … <code>bonuses[10]</code> || table || One table per bonus rank, with the fields below.
|-
| <code>bonuses[n].piecesRequired</code> || number || Number of pieces needed for this bonus. <code>0</code> for an unused rank.
|-
| <code>bonuses[n].rankType</code> || number || Bonus rank type.
|-
| <code>bonuses[n].statType</code> || number || Stat the bonus applies to.
|-
| <code>bonuses[n].statValue</code> || number || Size of the bonus.
|-
| <code>bonuses[n].isPercentage</code> || boolean || <code>true</code> if <code>statValue</code> is a percentage.
|}
* If the client has no data for the set, nothing happens. The function does not send a request to the server.
* Nothing happens if the player object does not exist yet.
* When the player object exists, the function reports one return value without pushing one, so Lua receives the value on top of the stack, which is the last argument passed. Do not rely on this.
* Exactly one argument must be passed.

== Errors ==
* <code>Error in function call 'RequestItemSet': ItemSetId must be valid.</code> (argument missing or not a number, in addition to the generic ''Invalid Parameters'' message)
* <code>Error in function call 'RequestItemSet': IteSetId cannot be 0.</code> (sic)

== Example ==
From <code>default/easystem_utils/source/datautils.lua</code>. <code>DataUtils.UpdateItemSets</code> handles <code>ITEM_SET_DATA_ARRIVED</code> and copies <code>GameData.UpdatedItemSet</code> into its own table:
<pre>
function DataUtils.GetItemSetData (itemSetId)
    if (itemSetId ~= nil) then
        if (ItemSetData[itemSetId] ~= nil) then
            return ItemSetData[itemSetId];
        end

        -- Otherwise, we need to request this from the client...
        RequestItemSet (itemSetId);
    end

    return nil;
end
</pre>

== See also ==
* [[API:RequestMoveItem|RequestMoveItem]]