Help Appending To In-Game Quest List

dominoid · 01/07/16, 07:49 PM

I really know it's going to be something dumb. I'm looking to add to the existing in-game quest list on the journal page.

From Wyykyd's Quest Tracker, I can use

Code:

local allQuests, allCategories, seenCategories = QUEST_JOURNAL_MANAGER:GetQuestListData()

to actually get all the quests and tree structure information. I thought I could hook or overload (I'm not sure the difference) QUEST_JOURNAL_MANAGER:GetQuestListData(), but unless I'm just missing it, the in-game journal doesn't seem to fire QUEST_JOURNAL_MANAGER:GetQuestListData() in the creation of the list. Perhaps it's firing before my add-on is loaded? But I could add to allQuests if I can get it to hook properly right?

Is this not the best way to do this? Should I be using a different method? Any help you can provide is appreciated. Also any hints or tidbits on the next steps, of getting my added quest to cycle when "T" is pressed or provide additional information in the journal panel when it's active or clicked would be appreciated as I am sure that will be my next stumbling block. ;-)

For those interested, I'm trying to build this. I got the questing logic and stuff worked out and functioning in an alpha state, but I'm trying to integrate most everything into the base UI to make it the best experience possible.

TIA

merlight · 01/07/16, 09:15 PM

Originally Posted by dominoid

I really know it's going to be something dumb. I'm looking to add to the existing in-game quest list on the journal page.

From Wyykyd's Quest Tracker, I can use

Code:

local allQuests, allCategories, seenCategories = QUEST_JOURNAL_MANAGER:GetQuestListData()

That method is only used at startup to create initial tables, so called master list, here http://esodata.uesp.net/current/src/...d.lua.html#229

You'll probably want to manipulate that questMasterList. But then you might run into issues with MAX_JOURNAL_QUESTS, the active quest limit.

Originally Posted by dominoid

I thought I could hook or overload (I'm not sure the difference)

You can't overload functions in Lua

There's no way to attach argument count/type restrictions to a function.

circonian · 01/07/16, 09:35 PM

Your looking for this:

Lua Code:

local function UpdateQuestInfo()
    local allQuests, allCategories, seenCategories = QUEST_JOURNAL_MANAGER:GetQuestListData()
    ...
    
end
 
local OrigRefreshQuestMasterList = ZO_QuestJournal_Keyboard.RefreshQuestMasterList
function ZO_QuestJournal_Keyboard:RefreshQuestMasterList()
    OrigRefreshQuestMasterList(self)
    
    UpdateQuestInfo()
end

Here is an example of how to do it:

Warning: Spoiler

Lua Code:

-- will hold your quest info
local MyQuestInfo = {
    categories      = {},
    seenCategories  = {},
    quests          = {},
}
 
-- Used to add categories to your quest table
local function AddQuestCategory(name, type)
    local category = {
        name = name,
        type = type,
    }
 
    MyQuestInfo.categories[name] = category
end
 
-- Used to add seen categories to your quest table
local function AddSeenCategory(name, seen)
    if not MyQuestInfo.seenCategories[name] then
        MyQuestInfo.seenCategories[name] = seen
    end
end
 
-- add other parameters for everything else, or pass in a table with
-- quest info, this is just a hardcoded simple example
local function AddCustomQuest(categoryName)
    local myQuest = {
        name            = "Test Quest",
        questIndex      = 473,
        level           = 49,
        questType       = 1,
        categoryName    = categoryName,
        categoryType    = 1,
        questType       = 0,
        displayType     = 0
    }
 
    MyQuestInfo.quests[myQuest.questIndex] = myQuest
end
 
-- adds your quests to the quest journal
local function AddMyQuestsToJournal()
    local categories        = MyQuestInfo.categories
    local seenCategories    = MyQuestInfo.seenCategories
    local quests            = MyQuestInfo.quests
    
    for k,catTable in pairs(categories) do
        table.insert(QUEST_JOURNAL_KEYBOARD.questMasterList.categories, catTable)
    end
 
    for k,seenCatTable in pairs(seenCategories) do
        table.insert(QUEST_JOURNAL_KEYBOARD.questMasterList.seenCategories, seenCatTable)
    end
    
    for k,questTable in pairs(quests) do
        table.insert(QUEST_JOURNAL_KEYBOARD.questMasterList.quests, questTable)
    end
    
    QUEST_JOURNAL_KEYBOARD:RefreshQuestList()
end
 
-- Just a test function to add some test quest
local function InitializeTestQuest()
    local categoryName = "Test Cateogry"
    
    -- Add this test quest to your quest table
    AddQuestCategory(categoryName, 1)
    AddSeenCategory(categoryName, true)
    AddCustomQuest(categoryName)
    
    -- manually call to update the journal since the journal
    -- has already been populated
    AddMyQuestsToJournal()
end
 
-- random do whatever you want/need here
-- if you need to inspect the quest journal quests, categories, seenCategories
-- you can get them here
-- Else just call AddMyQuestsToJournal() to add your quests to the journal
local function UpdateQuestInfo()
    --local allQuests, allCategories, seenCategories = QUEST_JOURNAL_MANAGER:GetQuestListData()
    
    AddMyQuestsToJournal()
end
 
local OrigRefreshQuestMasterList = ZO_QuestJournal_Keyboard.RefreshQuestMasterList
function ZO_QuestJournal_Keyboard:RefreshQuestMasterList()
    OrigRefreshQuestMasterList(self)
    
    -- If you need to do something to/with the quest journal quests, categories, seenCategories
    -- call this & do it there
    UpdateQuestInfo() 
    -- else you could just call this here instead
    --AddMyQuestsToJournal()
end

The above code allows you to create quest categories and quests and add them to the journal, but as merlight said there are problems you might run into like MAX_JOURNAL_QUESTS & all of the quest functions that use any quest info like questIndex. You would probably have to hook all of them and handle them yourself or you would probably crash any addon that works with quests. Also who knows what trouble you might run into if ZOS code runs some private functions or something server side and attempts to use your fake questIndex or any of your other fake quest info.

circonian · 01/07/16, 09:50 PM

Originally Posted by dominoid

Also any hints or tidbits on the next steps, of getting my added quest to cycle when "T" is pressed or provide additional information in the journal panel when it's active or clicked would be appreciated as I am sure that will be my next stumbling block. ;-)

That is one of the things I meant when I said you would probably have to hook a lot of functions involving quest info and handle them yourself. You would have to do it to get info to show on the journal page like the description, stepText, Condition text, hints, exc... It would also be required to get the "T" key to cycle to your quest properly.

dominoid · 01/08/16, 08:05 AM

Thank you both for going above and beyond. The code worked exactly as I had hoped. As pointed out, I will need to hook a bunch more. I will spend the day trying to figure it out. I THINK the code above combined with using MailR as a good "how to" for how they handled all hooks inside the messaging screen MIGHT get me there. Thanks again.

sirinsidiator · 01/08/16, 08:30 AM

Originally Posted by dominoid

Thank you both for going above and beyond. The code worked exactly as I had hoped. As pointed out, I will need to hook a bunch more. I will spend the day trying to figure it out. I THINK the code above combined with using MailR as a good "how to" for how they handled all hooks inside the messaging screen MIGHT get me there. Thanks again.

Just keep in mind that you should leave the original code path intact for other addons when you add your hooks. I think I remember that MailR simply replaced some methods in the past without calling the original function which made it incompatible with some features of AwesomeGuildStore, not sure if it has been updated in the meantime. If it is still the same it might not be the best example of how to achieve this.

dominoid · 01/08/16, 11:40 AM

Argh. Using MailR as an example, which apparently may not be the best case, I put this at the top:

Lua Code:

local GetJournalQuestInfo_Orig = GetJournalQuestInfo

Assigned the following in my intialization:

Lua Code:

GetJournalQuestInfo = QuestMaker.GetJournalQuestInfo

And created this:

Lua Code:

function QuestMaker:GetJournalQuestInfo(questIndex)
 
        local questName, bgText, stepText, stepType, stepOverrideText, completed, tracked, _, _, _, instanceDisplayType = GetJournalQuestInfo_Orig(questIndex)
        return questName, bgText, stepText, stepType, stepOverrideText, completed, tracked, _, _, _, instanceDisplayType
 
end

Which to my limited knowledge should simply run the original GetJournalQuestInfo, but questIndex is coming in nil. I got it to not come in nil once by accident, made some changes, and can't get it back. What am I missing? The plan would be to check the quest index number and if it's a custom quest pass back custom quest info, but if it's a vanilla quest to use the vanilla function as coded above.

Thank again.

dominoid · 01/08/16, 11:51 AM

Ok so changing QuestMaker:GetJournalQuestInfo to QuestMaker.GetJournalQuestInfo worked? What's the difference and why did it work for MailR and not mine?

Sorry for all the noob stuff. I swear I know what I'm outside of here. My problem is my base knowledge is VB.net syntax. If I really new C# or C++, the LUA syntax would look better to me (I think). That and I'm self taught.

votan · 01/08/16, 12:44 PM

Originally Posted by dominoid

Ok so changing QuestMaker:GetJournalQuestInfo to QuestMaker.GetJournalQuestInfo worked? What's the difference and why did it work for MailR and not mine?

Sorry for all the noob stuff. I swear I know what I'm outside of here. My problem is my base knowledge is VB.net syntax. If I really new C# or C++, the LUA syntax would look better to me (I think). That and I'm self taught.

The colon is syntax sugar.
function A:f(b,c,d) is equal to function f(self,b,c,d)
In both case is self the instance the method is called for.
So, if you save a reference of a function declared like A:f(b) it must be handled as f(self, b):

Lua Code:

local GetJournalQuestInfo_Orig = QuestMaker.GetJournalQuestInfo
function QuestMaker:GetJournalQuestInfo(questIndex)
-- Implicit created variable self, because of the colon syntax.
GetJournalQuestInfo_Orig(self, questIndex)
end

Which is the same as:

Lua Code:

local GetJournalQuestInfo_Orig = QuestMaker.GetJournalQuestInfo
function QuestMaker.GetJournalQuestInfo(self, questIndex)
GetJournalQuestInfo_Orig(self, questIndex)
end

Which is the same as:

Lua Code:

local GetJournalQuestInfo_Orig = QuestMaker.GetJournalQuestInfo
QuestMaker.GetJournalQuestInfo = function(self, questIndex)
GetJournalQuestInfo_Orig(self, questIndex)
end

dominoid · 01/09/16, 04:59 PM

Thanks you. I'm still not sure why it worked for one addon and not the other, but I understand a little better. ;-)

circonian · 01/09/16, 07:19 PM

I may not be 100% accurate on how I try to explain, but this should at least give you an idea of what the problem is.

As Votan said when you do this:

Lua Code:

function QuestMaker:SomeFunction(questIndex)

It is expecting a QuestMaker object to be used to call the function, something like

Lua Code:

QuestMaker:GetJournalQuestInfo(questIndex)

It is expecting two parameters: self and questIndex.
Where QuestMaker (the object before the : colon) becomes the first parameter called self. So even though you did not write (self, questIndex) as your parameters that is what happens. The QuestMaker object automatically becomes the first parameter called self.

Since GetJournalQuestInfo (the original function) does not belong to the QuestMaker object. Meaning it (the original function) is not defined as:

Lua Code:

function QuestMaker:GetJournalQuestInfo(questIndex)

It is defined as:

Lua Code:

function GetJournalQuestInfo(questIndex)

So it is called without a colon & no object before it. So its only expecting a single parameter: questIndex.

But since you assigned the original function to reference

Lua Code:

QuestMaker:GetJournalQuestInfo(questIndex)

Now when we call the original function it is now expecting two parameters: self (a QuestMaker object) & questIndex, but we don't call the function in that way. We only call it as

Lua Code:

GetJournalQuestInfo(questIndex)

Which causes the problem. When you call GetJournalQuestInfo(questIndex), remember since you redirected it to QuestMaker:GetJournalQuestInfo it is expecting two parameters (self, questIndex), so questIndex is the first parameter and it is becoming self and there is no other parameter so questIndex is nil.

You should make it something like

Lua Code:

local GetJournalQuestInfo_Orig = GetJournalQuestInfo
 
function GetJournalQuestInfo(questIndex)
   local questName, bgText, stepText, stepType, stepOverrideText, completed, tracked, _, _, _, instanceDisplayType = GetJournalQuestInfo_Orig(questIndex)
   return questName, bgText, stepText, stepType, stepOverrideText, completed, tracked, _, _, _, instanceDisplayType
end