Back to Home

ESO Lua File v100032

ingame/zo_quest/questjournal_shared.lua

[◄ back to folders ]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
---------------------
--Quest Journal Shared
---------------------
-- Used for indexing into icon/tooltip tables if we don't care what the quest or instance display types are
ZO_ANY_QUEST_TYPE = "all_quests"
ZO_ANY_INSTANCE_DISPLAY_TYPE = "all_instances"
ZO_QuestJournal_Shared = ZO_CallbackObject:Subclass()
function ZO_QuestJournal_Shared:New()
    local newObject = ZO_CallbackObject.New(self)
    return newObject
end
function ZO_QuestJournal_Shared:Initialize(control)
    self.control = control
    self.listDirty = true
    self.questStrings = {}
    self.icons = {}
    self.tooltips = {}
    self:RegisterIcons()
    control:RegisterForEvent(EVENT_QUEST_ADDED, function() self:OnQuestsUpdated() end)
    control:RegisterForEvent(EVENT_QUEST_REMOVED, function() self:OnQuestsUpdated() end)
    control:RegisterForEvent(EVENT_QUEST_LIST_UPDATED, function() self:OnQuestsUpdated() end)
    control:RegisterForEvent(EVENT_QUEST_ADVANCED, function(eventCode, questIndex) self:OnQuestAdvanced(questIndex) end)
    control:RegisterForEvent(EVENT_QUEST_CONDITION_COUNTER_CHANGED, function(eventCode, ...) self:OnQuestConditionInfoChanged(...) end)
    control:RegisterForEvent(EVENT_LEVEL_UPDATE, function(eventCode, unitTag) self:OnLevelUpdated(unitTag) end)
end
local function QuestJournal_Shared_RegisterDataInTable(table, questType, instanceDisplayType, data)
    local questTableIndex = questType or ZO_ANY_QUEST_TYPE
    table[questTableIndex] = table[questTableIndex] or {}
    table[questTableIndex][instanceDisplayType or ZO_ANY_INSTANCE_DISPLAY_TYPE] = data
end
local function QuestJournal_Shared_GetDataFromTable(table, questType, instanceDisplayType)
    local data
    -- Attempt to pull data specifically for this quest type first
    if table[questType] then
        data = table[questType][instanceDisplayType] or table[questType][ZO_ANY_INSTANCE_DISPLAY_TYPE]
    end
    -- If we didn't find specific data for this quest type, try to fetch it for any quest type
    if data == nil and table[ZO_ANY_QUEST_TYPE] then
        data = table[ZO_ANY_QUEST_TYPE][instanceDisplayType] or table[ZO_ANY_QUEST_TYPE][ZO_ANY_INSTANCE_DISPLAY_TYPE]
    end
    return data
end
--TODO: Get ride of this exstensibility. The icon should only be controlled by the display type.
function ZO_QuestJournal_Shared:RegisterIconTexture(questType, instanceDisplayType, texturePath)
    QuestJournal_Shared_RegisterDataInTable(self.icons, questType, instanceDisplayType, texturePath)
end
function ZO_QuestJournal_Shared:GetIconTexture(questType, instanceDisplayType)
    return QuestJournal_Shared_GetDataFromTable(self.icons, questType, instanceDisplayType)
end
function ZO_QuestJournal_Shared:RegisterTooltipText(questType, instanceDisplayType, stringIdOrText, paramsFunction)
    local tooltipText = type(stringIdOrText) == "number" and GetString(stringIdOrText) or stringIdOrText
    local data = tooltipText
    if paramsFunction then 
        data =
        {
            text = tooltipText,
            paramsFunction = paramsFunction,
        }
    end
    QuestJournal_Shared_RegisterDataInTable(self.tooltips, questType, instanceDisplayType, data)
end
function ZO_QuestJournal_Shared:GetTooltipText(questType, instanceDisplayType, questIndex)
    local data = QuestJournal_Shared_GetDataFromTable(self.tooltips, questType, instanceDisplayType)
    local text = data
    if type(data) == "table" then
        text = zo_strformat(data.text, data.paramsFunction(questIndex))
    end
    return text
end
function ZO_QuestJournal_Shared:InitializeQuestList()
    -- Should be overridden
end
function ZO_QuestJournal_Shared:InitializeKeybindStripDescriptors()
    -- Should be overridden
end
function ZO_QuestJournal_Shared:InitializeScenes()
    -- Should be overridden
end
function ZO_QuestJournal_Shared:GetSelectedQuestData()
    -- Should be overridden
end
function ZO_QuestJournal_Shared:RefreshQuestList()
    -- Should be overridden
end
function ZO_QuestJournal_Shared:RegisterIcons()
    -- Should be overridden
end
function ZO_QuestJournal_Shared:RegisterTooltips()
    -- Should be overridden
end
function ZO_QuestJournal_Shared:OnLevelUpdated(unitTag)
    if (unitTag == "player") then
        if self.control:IsHidden() then
            self.listDirty = true
        else
            self:RefreshQuestList()
        end
    end
end
function ZO_QuestJournal_Shared:BuildTextForStepVisibility(questIndex, visibilityType)
    local numSteps = GetJournalQuestNumSteps(questIndex)
    local questStrings = self.questStrings
    for stepIndex = 2, numSteps do
        local stepJournalText, visibility, _, stepOverrideText, _ = GetJournalQuestStepInfo(questIndex, stepIndex)
        if visibility == visibilityType then
            if(stepJournalText ~= "") then
                table.insert(questStrings, zo_strformat(SI_QUEST_JOURNAL_TEXT, stepJournalText))
            end
            
            if stepOverrideText and (stepOverrideText ~= "") then
                table.insert(questStrings, stepOverrideText)
            end
        end
    end
end
function ZO_QuestJournal_Shared:GetSelectedQuestIndex()
    local selectedData = self:GetSelectedQuestData()
    return selectedData and selectedData.questIndex
end
function ZO_QuestJournal_Shared:CanAbandonQuest()
    local selectedData = self:GetSelectedQuestData()
    if selectedData and selectedData.questIndex and selectedData.questType ~= QUEST_TYPE_MAIN_STORY then
        return true
    end
    return false
end
function ZO_QuestJournal_Shared:CanShareQuest()
    local selectedQuestIndex = self:GetSelectedQuestIndex()
    if selectedQuestIndex then
        return GetIsQuestSharable(selectedQuestIndex) and IsUnitGrouped("player")
    end
    return false
end
function ZO_QuestJournal_Shared:RefreshDetails()
    --to be overridden
end
function ZO_QuestJournal_Shared:RefreshQuestCount()
    -- This function is overridden by sub-classes.
end
function ZO_QuestJournal_Shared:RefreshQuestMasterList()
    -- Override if necesary
end
function ZO_QuestJournal_Shared:OnQuestsUpdated()
    if self.control:IsHidden() then
        self.listDirty = true
    else
        self:RefreshQuestCount()
        self:RefreshQuestList()
    end
end
function ZO_QuestJournal_Shared:OnQuestAdvanced(questIndex)
    local selectedQuestIndex = self:GetSelectedQuestIndex()
    if questIndex == selectedQuestIndex then
        self:RefreshDetails()
    end
end
function ZO_QuestJournal_Shared:OnQuestConditionInfoChanged(questIndex, questName, conditionText, conditionType, curCondtionVal, newConditionVal, conditionMax, isFailCondition, stepOverrideText, isPushed, isQuestComplete, isConditionComplete, isStepHidden, isConditionCompleteStatusChanged, isConditionCompletableBySiblingStatusChanged)
    local selectedQuestIndex = self:GetSelectedQuestIndex()
    if questIndex == selectedQuestIndex then
        self:RefreshDetails()
    end
end
function ZO_QuestJournal_Shared:ShowOnMap()
   local selectedQuestIndex = self:GetSelectedQuestIndex()
   if(selectedQuestIndex) then
        ZO_WorldMap_ShowQuestOnMap(selectedQuestIndex)
    end
end