Exdata definitions

Escutcheons
Weapon unlock
Soul plate
Soul reflectors
Fish

Co-Authored-By: atom0s <atom0s@users.noreply.github.com>

Author: sruon

scripts/commands/addfish.lua

@@ -17,32 +17,32 @@ local function error(player, msg)
     player:printToPlayer('!addfish <fish> <length> <weight> <optional:ranked>')
 end
 
-commandObj.onTrigger = function(player, item, length, weight, ranked)
+commandObj.onTrigger = function(player, itemId, length, weight, ranked)
     -- Load needed text ids for players current zone..
     local ID = zones[player:getZoneID()]
     local itemToGet = 0
     ranked = ranked and 1 or 0
 
     -- validate item
-    if item == nil then
+    if itemId == nil then
         -- No Item Provided
         error(player, 'No Item ID given.')
         return
-    elseif item ~= nil and tonumber(item) == nil then
+    elseif itemId ~= nil and tonumber(itemId) == nil then
         -- Item was provided, but was not a number.  Try text lookup.
         local retItems = utils.filterArray(xi.fishingContest.fish, function(_, fish)
-            return fish.name == item
+            return fish.name == itemId
         end)
 
         if #retItems ~= 1 then
-            player:printToPlayer(string.format('Item %s not found in fish table.', item))
+            player:printToPlayer(string.format('Item %s not found in fish table.', itemId))
             return
         end
 
         itemToGet = retItems[1].id
-    elseif tonumber(item) ~= nil then
+    elseif tonumber(itemId) ~= nil then
         -- Number was provided, so just use it
-        itemToGet = item
+        itemToGet = itemId
     end
 
     -- At this point, if there's no item found, exit out of the function
@@ -68,11 +68,14 @@ commandObj.onTrigger = function(player, item, length, weight, ranked)
         return
     end
 
-    -- Give the GM the item...
-    local obtained = player:addItem({ id = itemToGet,
-                                    quantity = 1,
-                                    exdata = xi.fishingContest.createExData(length, weight, ranked) })
-    if obtained then
+    -- Give the GM the item and set exdata...
+    local item = player:addItem({ id = itemToGet, quantity = 1 })
+    if item then
+        item:setExData({
+            size     = length,
+            weight   = weight,
+            isRanked = ranked == 1,
+        })
         player:messageSpecial(ID.text.ITEM_OBTAINED, itemToGet)
     end
 end

scripts/enum/item.lua

@@ -1657,13 +1657,15 @@ xi.item =
     CHUNK_OF_KAOLIN                     = 2475,
     SPOOL_OF_PLATINUM_SILK_THREAD       = 2476,
     SOUL_PLATE                          = 2477,
+    SOUL_REFLECTOR                      = 2478,
     CHOCOBET_TICKET                     = 2479,
     RACE_COMPLETION_CERTIFICATE         = 2481,
     MERCENARY_CAMP_ENTRY_SLIP           = 2487,
     ALEXANDRITE                         = 2488,
     FORBIDDEN_KEY                       = 2490,
     LEUJAOAM_OBSERVATION_LOG            = 2491,
     ILRUSI_TRAVEL_LEDGER                = 2495,
+    OFFICIAL_SOUL_REFLECTOR             = 2500,
     BLACK_PUPPET_TURBAN                 = 2501,
     WHITE_PUPPET_TURBAN                 = 2502,
     HANDFUL_OF_ALMONDS                  = 2503,
@@ -10510,6 +10512,7 @@ xi.item =
     TWINNED_SHIELD                      = 26414,
     ADAPA_SHIELD                        = 26420,
     NUSKU_SHIELD                        = 26421,
+    JOINERS_ASPIS                       = 26423,
     DIAMOND_ASPIS                       = 26488,
     TROTH                               = 26489,
     POROGGO_FLEECE                      = 26514,

scripts/globals/fishing_contest.lua

@@ -4,13 +4,6 @@
 xi = xi or {}
 xi.fishingContest = xi.fishingContest or {}
 
-local exDataIndex =
-{
-    LENGTH = 0x00,
-    WEIGHT = 0x02,
-    RANKED = 0x04,
-}
-
 xi.fishingContest.fish =
 {
     -- NOTE: If you don't want certain fish included in the contest (era restrictions, or whatever),
@@ -119,8 +112,6 @@ local function findFishSlot(trade, fish)
     return 0
 end
 
--- The npcUtil.giveItem function currently does not support custom exdata
--- Since we need to include the measurements of the fish, we need a modified function
 local function giveFish(player, params)
     params = params or {}
     local ID = zones[player:getZoneID()]
@@ -134,7 +125,12 @@ local function giveFish(player, params)
     end
 
     -- give items to player
-    if player:addItem(params) then
+    local fishItem = player:addItem({ id = fishid, quantity = params.quantity or 1 })
+    if fishItem then
+        if params.exdata then
+            fishItem:setExData(params.exdata)
+        end
+
         player:messageSpecial(ID.text.ITEM_OBTAINED, fishid)
     else
         player:messageSpecial(ID.text.ITEM_CANNOT_BE_OBTAINED, fishid)
@@ -230,56 +226,6 @@ end
 -- GLOBAL FUNCTIONS
 -----------------------------------
 
--- Create the table of exdata
-xi.fishingContest.createExData = function(length, weight, ranked)
-    -- If the provided data table has a nil value, the key will not be passed to the setExData function
-    -- setExData only accepts one-byte keys and vals so we need to break down the 16-bit vars
-    local exData = {}
-    if length ~= nil then
-        exData[exDataIndex.LENGTH    ] = bit.band(length, 0x00FF)
-        exData[exDataIndex.LENGTH + 1] = bit.rshift(bit.band(length, 0xFF00), 8)
-    end
-
-    if weight ~= nil then
-        exData[exDataIndex.WEIGHT    ] = bit.band(weight, 0x00FF)
-        exData[exDataIndex.WEIGHT + 1] = bit.rshift(bit.band(weight, 0xFF00), 8)
-    end
-
-    if ranked ~= nil then
-        exData[exDataIndex.RANKED    ] = ranked
-    end
-
-    return exData
-end
-
--- Read the necessary data from the exdata
-xi.fishingContest.getFishData = function(fishItem)
-    local fishData = fishItem:getExData()
-    local fishTable = {}
-
-    fishTable['length'] = (bit.lshift(fishData[exDataIndex.LENGTH + 1], 8) + fishData[exDataIndex.LENGTH]) or 0
-    fishTable['weight'] = (bit.lshift(fishData[exDataIndex.WEIGHT + 1], 8) + fishData[exDataIndex.WEIGHT]) or 0
-    fishTable['ranked'] = fishData[exDataIndex.RANKED]
-
-    return fishTable
-end
-
--- Update the fish exdata
-xi.fishingContest.setFishData = function(fishItem, length, weight, ranked)
-    -- Data Table should have only three possible options: 'length', 'width', and 'ranked'
-    if fishItem == nil then
-        return
-    end
-
-    -- If the provided data table has a nil value, the key will not be passed to the setExData function
-    -- setExData only accepts one-byte keys and vals so we need to break down the 16-bit vars
-    local newExData = xi.fishingContest.createExData(length, weight, ranked)
-
-    if newExData ~= nil then
-        fishItem:setExData(newExData)
-    end
-end
-
 xi.fishingContest.selectContestFish = function()
     return utils.randomEntry(xi.fishingContest.fish)['id']
 end
@@ -327,25 +273,25 @@ xi.fishingContest.onTrade = function(player, npc, trade)
         npcUtil.tradeHasExactly(trade, contest['fishid'])
     then
         local fishItem = trade:getItem(findFishSlot(trade, contest['fishid']))
-        local fishData = xi.fishingContest.getFishData(fishItem)
+        local fishData = fishItem:getExData()
 
         if fishData == nil then
             return
         elseif
-            fishData['ranked'] == 1 or
-            fishData['length'] == 0 or
-            fishData['weight'] == 0
+            fishData.isRanked or
+            fishData.size == 0 or
+            fishData.weight == 0
         then
             -- Fish has already been ranked previously
             player:startEvent(10007, { [4] = 1 })
         else
             -- Fish is a valid entry, not previously ranked
             -- Player local vars used to hold submission data until end of event
-            player:setLocalVar('[FishContest]Length', fishData['length'])
-            player:setLocalVar('[FishContest]Weight', fishData['weight'])
+            player:setLocalVar('[FishContest]Length', fishData.size)
+            player:setLocalVar('[FishContest]Weight', fishData.weight)
 
             player:startEvent(10007, {
-                [5] = scoreFish(fishData['length'], fishData['weight'], contest['criteria']),
+                [5] = scoreFish(fishData.size, fishData.weight, contest['criteria']),
                 [6] = player:getContestScore(),
             })
         end
@@ -452,7 +398,7 @@ xi.fishingContest.onEventFinish = function(player, csid, option, npc)
             local weight = player:getLocalVar('[FishContest]Weight')
             local obtained = giveFish(player, { id = contest['fishid'],
                                                 quantity = 1,
-                                                exdata = xi.fishingContest.createExData(length, weight, 1) })
+                                                exdata = { size = length, weight = weight, isRanked = true } })
             if obtained then
                 player:confirmTrade()
                 player:delGil(500) -- Pay the registration fee of 500 gil.