[TFS 1.X][Canary/OTBR] 'Fix' books without text on Quest System

[Liikuid]

Hello!

This post is here to fix a little problem I found (specially on canary sources). When using the original Quest System in TFS or Canary, OTservers, I noticed that books didn't show their text when you added them to a chest, container, or any object with the Quest System (action 2000) enabled on MapEditors.

It's not a big thing, but it saves you from having to make custom scripts for each book in many situations.



To fix this you need to add the next code lines (quest_system1.lua):

        newItem:setAttribute(ITEM_ATTRIBUTE_TEXT, originalItem:getAttribute(ITEM_ATTRIBUTE_TEXT))

            local newText = item:getAttribute(ITEM_ATTRIBUTE_TEXT)
            if newText then
                newItem:setAttribute(ITEM_ATTRIBUTE_TEXT, originalItem:getAttribute(ITEM_ATTRIBUTE_TEXT))
            end

        local itemText = item:getAttribute(ITEM_ATTRIBUTE_TEXT)
        if itemText then
            reward:setAttribute(ITEM_ATTRIBUTE_TEXT, originalItem:getAttribute(ITEM_ATTRIBUTE_TEXT))
        end

In my case, Canary, the quest system (action 2000) got modified as follows:

local specialQuests = {
    -- {x = 32752, y = 32343, z = 14}
    [52167] = Storage.DreamersChallenge.Reward,
    -- {x = 32806, y = 32230, z = 11}
    [52003] = Storage.PitsOfInferno.WeaponReward,
    -- {x = 32311, y = 32211, z = 8}
    [51400] = Storage.ThievesGuild.Reward,
    [51324] = Storage.WrathoftheEmperor.MainReward,
    -- {x = 32232, y = 31066, z = 7}
    [51715] = Storage.SvargrondArena.RewardGreenhorn,
    -- {x = 32232, y = 31059, z = 7}
    [51716] = Storage.SvargrondArena.RewardScrapper,
    -- {x = 32232, y = 31052, z = 7}
    [51717] = Storage.SvargrondArena.RewardWarlord
}

local questsExperience = {
    [3101] = 1 -- dummy values
}

local questLog = {
    [8213] = Storage.HiddenCityOfBeregar.DefaultStart
}

local tutorialIds = {
    [50080] = 5,
    [50082] = 6,
    [50084] = 10,
    [50086] = 11
}

local function copyContainerItem(originalContainer, newContainer)
    for i = 0, originalContainer:getSize() - 1 do
        local originalItem = originalContainer:getItem(i)
        local newItem = Game.createItem(originalItem.itemid, originalItem.type)
        newItem:setActionId(originalItem:getActionId())
        newItem:setAttribute(ITEM_ATTRIBUTE_DESCRIPTION, originalItem:getAttribute(ITEM_ATTRIBUTE_DESCRIPTION))
        newItem:setAttribute(ITEM_ATTRIBUTE_TEXT, originalItem:getAttribute(ITEM_ATTRIBUTE_TEXT))
        if originalItem:isContainer() then
            copyContainerItem(Container(originalItem.uid), Container(newItem.uid))
        end
        newContainer:addItemEx(newItem)
    end
end

local hotaQuest = { 50950, 50951, 50952, 50953, 50954, 50955 }

local questSystem1 = Action()

function questSystem1.onUse(player, item, fromPosition, target, toPosition, isHotkey)
    local storage = specialQuests[item.actionid]
    if not storage then
        storage = item.uid
        if storage > 65535 then
            return false
        end
    end

    if storage == 23644 or storage == 24632 or storage == 14338 then
        player:setStorageValue(Storage.SvargrondArena.PitDoor, -1)
    end

    if player:getStorageValue(storage) > 0 and player:getGroup():getId() < GROUP_TYPE_GAMEMASTER then
        player:sendTextMessage(MESSAGE_EVENT_ADVANCE, 'The ' .. ItemType(item.itemid):getName() .. ' is empty.')
        return true
    end

    local items, reward = {}
    local size = item:isContainer() and item:getSize() or 0
    if size == 0 then
        reward = Game.createItem(item.itemid, item.type)
        if not reward then
            logger.error("[questSystem1.onUse] failed to create reward item")
            return false
        end

        local itemActionId = item:getActionId()
        if itemActionId then
            reward:setActionId(itemActionId)
        end
        local itemDescription = item:getAttribute(ITEM_ATTRIBUTE_DESCRIPTION)
        if itemDescription then
            reward:setAttribute(ITEM_ATTRIBUTE_DESCRIPTION, itemDescription)
        end
        local itemText = item:getAttribute(ITEM_ATTRIBUTE_TEXT)
        if itemText then
            reward:setAttribute(ITEM_ATTRIBUTE_TEXT, originalItem:getAttribute(ITEM_ATTRIBUTE_TEXT))
        end     
      
    else
        local container = Container(item.uid)
        for i = 0, container:getSize() - 1 do
            local originalItem = container:getItem(i)
            local newItem = Game.createItem(originalItem.itemid, originalItem.type)
            if not newItem then
                logger.error("[questSystem1.onUse] failed to create new item")
                return false
            end
            local newActionId = originalItem:getActionId()
            if newActionId then
                newItem:setActionId(newActionId)
            end
            local newDescription = item:getAttribute(ITEM_ATTRIBUTE_DESCRIPTION)
            if newDescription then
                newItem:setAttribute(ITEM_ATTRIBUTE_DESCRIPTION, newDescription)
            end

            local newText = item:getAttribute(ITEM_ATTRIBUTE_TEXT)
            if newText then
                newItem:setAttribute(ITEM_ATTRIBUTE_TEXT, originalItem:getAttribute(ITEM_ATTRIBUTE_TEXT))
            end

            if originalItem:isContainer() then
                copyContainerItem(Container(originalItem.uid), Container(newItem.uid))
            end
            items[#items+1] = newItem
        end

        if size == 1 then
            reward = items[1]
        end
    end

    local result = ''
    if reward then
        local ret = ItemType(reward.itemid)
        if ret:isRune() then
            result = ret:getArticle() .. ' ' .. ret:getName() .. ' (' .. reward.type .. ' charges)'
        elseif ret:isStackable() and reward:getCount() > 1 then
            result = reward:getCount() .. ' ' .. ret:getPluralName()
        elseif ret:getArticle() ~= '' then
            result = ret:getArticle() .. ' ' .. ret:getName()
        else
            result = ret:getName()
        end
    else
        if size > 20 then
            reward = Game.createItem(item.itemid, 1)
        elseif size > 8 then
            reward = Game.createItem(2854, 1)
        else
            reward = Game.createItem(2853, 1)
        end

        for i = 1, size do
            local tmp = items[i]
            if reward:addItemEx(tmp) ~= RETURNVALUE_NOERROR then
                logger.warn("[questSystem1.onUse] - Could not add quest reward to container")
            end
        end
        local ret = ItemType(reward.itemid)
        result = ret:getArticle() .. ' ' .. ret:getName()
    end

    if player:addItemEx(reward) ~= RETURNVALUE_NOERROR then
        local weight = reward:getWeight()
        if player:getFreeCapacity() < weight then
            player:sendCancelMessage(string.format('You have found %s weighing %.2f oz. You have no capacity.', result, (weight / 100)))
        else
            player:sendCancelMessage('You have found ' .. result .. ', but you have no room to take it.')
        end
        return true
    end

    if questsExperience[storage] then
        player:addExperience(questsExperience[storage], true)
    end

    if questLog[storage] then
        player:setStorageValue(questLog[storage], 1)
    end

    if tutorialIds[storage] then
        player:sendTutorial(tutorialIds[storage])
        if item.uid == 50080 then
            player:setStorageValue(Storage.RookgaardTutorialIsland.SantiagoNpcGreetStorage, 3)
        end
    end

    if table.contains(hotaQuest, item.uid) then
        if player:getStorageValue(Storage.TheAncientTombs.DefaultStart) ~= 1 then
            player:setStorageValue(Storage.TheAncientTombs.DefaultStart, 1)
        end
    end

    player:sendTextMessage(MESSAGE_EVENT_ADVANCE, 'You have found ' .. result .. '.')
    player:setStorageValue(storage, 1)
    return true
end

for index, value in pairs(specialQuests) do
    questSystem1:aid(index)
end

questSystem1:aid(2000)
questSystem1:register()