ESO Lua File v100010

ingame/tooltip/abilitytooltips.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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
--Section Generators
function ZO_Tooltip:AddAbilityName(abilityId, hideRank, overrideRank)
    local abilityName = GetAbilityName(abilityId)
    local rank = overrideRank
    if(overrideRank == nil) then
        rank = GetAbilityProgressionRankFromAbilityId(abilityId)
    end
    if(not hideRank and rank ~= nil and rank > 0) then
        self:AddLine(zo_strformat(SI_ABILITY_NAME_AND_RANK, abilityName, rank), self:GetStyle("title"))
    else
        self:AddLine(zo_strformat(SI_ABILITY_TOOLTIP_NAME, abilityName), self:GetStyle("title"))
    end
end
function ZO_Tooltip:AddAbilityProgressBar(currentXP, lastRankXP, nextRankXP, atMorph)
    local bar = self:AcquireStatusBar(self:GetStyle("abilityProgressBar"))
    if(nextRankXP == 0) then
        bar:SetMinMax(0, 1)
        bar:SetValue(1)
    else
        bar:SetMinMax(0, nextRankXP - lastRankXP)
        bar:SetValue(currentXP - lastRankXP)
    end
    self:AddStatusBar(bar)
end
function ZO_Tooltip:AddAbilityStats(abilityId)
    local statsSection = self:AcquireSection(self:GetStyle("abilityStatsSection"))
    --Cast Time
    local channeled, castTime, channelTime = GetAbilityCastInfo(abilityId)
    local castTimePair = statsSection:AcquireStatValuePair(self:GetStyle("statValuePair"))
    if(channeled) then
        castTimePair:SetStat(GetString(SI_ABILITY_TOOLTIP_CHANNEL_TIME_LABEL), self:GetStyle("statValuePairStat"))
        castTimePair:SetValue(ZO_FormatTimeMilliseconds(channelTime, TIME_FORMAT_STYLE_CHANNEL_TIME, TIME_FORMAT_PRECISION_TENTHS_RELEVANT, TIME_FORMAT_DIRECTION_NONE), self:GetStyle("statValuePairValue"))
    else
        castTimePair:SetStat(GetString(SI_ABILITY_TOOLTIP_CAST_TIME_LABEL), self:GetStyle("statValuePairStat"))
        castTimePair:SetValue(ZO_FormatTimeMilliseconds(castTime, TIME_FORMAT_STYLE_CAST_TIME, TIME_FORMAT_PRECISION_TENTHS_RELEVANT, TIME_FORMAT_DIRECTION_NONE), self:GetStyle("statValuePairValue"))
    end
    statsSection:AddStatValuePair(castTimePair)
    --Target
    local targetDescription = GetAbilityTargetDescription(abilityId)
    if(targetDescription) then
        local targetPair = statsSection:AcquireStatValuePair(self:GetStyle("statValuePair"))
        targetPair:SetStat(GetString(SI_ABILITY_TOOLTIP_TARGET_TYPE_LABEL), self:GetStyle("statValuePairStat"))
        targetPair:SetValue(targetDescription, self:GetStyle("statValuePairValue"))
        statsSection:AddStatValuePair(targetPair)
    end
    --Range
    local minRangeCM, maxRangeCM = GetAbilityRange(abilityId)
    if(maxRangeCM > 0) then
        local rangePair = statsSection:AcquireStatValuePair(self:GetStyle("statValuePair"))
        rangePair:SetStat(GetString(SI_ABILITY_TOOLTIP_RANGE_LABEL), self:GetStyle("statValuePairStat"))
        if(minRangeCM == 0) then
            rangePair:SetValue(zo_strformat(SI_ABILITY_TOOLTIP_RANGE, FormatFloatRelevantFraction(maxRangeCM / 100)), self:GetStyle("statValuePairValue"))
        else
            rangePair:SetValue(zo_strformat(SI_ABILITY_TOOLTIP_MIN_TO_MAX_RANGE, FormatFloatRelevantFraction(minRangeCM / 100), FormatFloatRelevantFraction(maxRangeCM / 100)), self:GetStyle("statValuePairValue"))
        end
        statsSection:AddStatValuePair(rangePair)
    end
    --Radius/Distance
    local radiusCM = GetAbilityRadius(abilityId)
    local distanceCM = GetAbilityAngleDistance(abilityId)
    if(radiusCM > 0) then
        local radiusDistancePair = statsSection:AcquireStatValuePair(self:GetStyle("statValuePair"))
        if(distanceCM > 0) then
            radiusDistancePair:SetStat(GetString(SI_ABILITY_TOOLTIP_AREA_LABEL), self:GetStyle("statValuePairStat"))
            radiusDistancePair:SetValue(zo_strformat(SI_ABILITY_TOOLTIP_AOE_DIMENSIONS, FormatFloatRelevantFraction(radiusCM / 100), FormatFloatRelevantFraction(distanceCM / 100)), self:GetStyle("statValuePairValue"))
        else
            radiusDistancePair:SetStat(GetString(SI_ABILITY_TOOLTIP_RADIUS_LABEL), self:GetStyle("statValuePairStat"))
            radiusDistancePair:SetValue(zo_strformat(SI_ABILITY_TOOLTIP_RADIUS, FormatFloatRelevantFraction(radiusCM / 100)), self:GetStyle("statValuePairValue")) 
        end
        statsSection:AddStatValuePair(radiusDistancePair)
    end
    --Duration
    local durationMS = GetAbilityDuration(abilityId)
    if(durationMS > 0) then
        local durationPair = statsSection:AcquireStatValuePair(self:GetStyle("statValuePair"))
        durationPair:SetStat(GetString(SI_ABILITY_TOOLTIP_DURATION_LABEL), self:GetStyle("statValuePairStat"))
        durationPair:SetValue(ZO_FormatTimeMilliseconds(durationMS, TIME_FORMAT_STYLE_DURATION, TIME_FORMAT_PRECISION_TENTHS_RELEVANT, TIME_FORMAT_DIRECTION_NONE), self:GetStyle("statValuePairValue"))
        statsSection:AddStatValuePair(durationPair)
    end
    --Cost
    local cost, mechanic = GetAbilityCost(abilityId)
    if(cost > 0) then
        local costPair = statsSection:AcquireStatValuePair(self:GetStyle("statValuePair"))
        costPair:SetStat(GetString(SI_ABILITY_TOOLTIP_RESOURCE_COST_LABEL), self:GetStyle("statValuePairStat"))
        local mechanicName = GetString("SI_COMBATMECHANICTYPE", mechanic)
        costPair:SetValue(zo_strformat(SI_ABILITY_TOOLTIP_RESOURCE_COST, cost, mechanicName), self:GetStyle("statValuePairValue"))
        statsSection:AddStatValuePair(costPair)
    end
    self:AddSection(statsSection)
end
function ZO_Tooltip:AddAbilityDescription(abilityId, pendingChampionPoints)
    local descriptionHeader = GetAbilityDescriptionHeader(abilityId)
    local description
    if not pendingChampionPoints then
        description = GetAbilityDescription(abilityId)
    else
        description = GetChampionAbilityDescription(abilityId, pendingChampionPoints)
    end
    if(descriptionHeader ~= "" or description ~= "") then
        local descriptionSection = self:AcquireSection(self:GetStyle("bodySection"))
        if(descriptionHeader ~= "") then
            descriptionSection:AddLine(zo_strformat(SI_ABILITY_TOOLTIP_DESCRIPTION_HEADER, descriptionHeader), self:GetStyle("bodyHeader"))
        end
        if(description ~= "") then
            descriptionSection:AddLine(zo_strformat(SI_ABILITY_TOOLTIP_DESCRIPTION, description), self:GetStyle("bodyDescription"))
        end
        self:AddSection(descriptionSection)
    end
end
function ZO_Tooltip:AddAbilityUpgrades(...)
    local numUpgradeReturns = select("#", ...)
    if(numUpgradeReturns > 0) then
        for i = 1, numUpgradeReturns, 3 do
            local label, oldValue, newValue = select(i, ...)
            local upgradeSection = self:AcquireSection(self:GetStyle("bodySection"))
            upgradeSection:AddLine(GetString(SI_ABILITY_TOOLTIP_UPGRADE), self:GetStyle("abilityUpgrade"), self:GetStyle("bodyHeader"))
            upgradeSection:AddLine(zo_strformat(SI_ABILITY_TOOLTIP_UPGRADE_FORMAT, label, oldValue, newValue), self:GetStyle("abilityUpgrade"), self:GetStyle("bodyDescription"))
            self:AddSection(upgradeSection)
        end
    end
end
function ZO_Tooltip:AddAbilityNewEffects(...)
    local numNewEffectReturns = select("#", ...)
    if(numNewEffectReturns > 0) then
        for i = 1, numNewEffectReturns do
            local newEffect = select(i, ...)
            local newEffectSection = self:AcquireSection(self:GetStyle("bodySection"))
            newEffectSection:AddLine(GetString(SI_ABILITY_TOOLTIP_NEW_EFFECT), self:GetStyle("abilityUpgrade"), self:GetStyle("bodyHeader"))
            newEffectSection:AddLine(newEffect, self:GetStyle("abilityUpgrade"), self:GetStyle("bodyDescription"))
            self:AddSection(newEffectSection)
        end
    end
end
--Layout Functions
function ZO_Tooltip:LayoutAbility(abilityId, hideRank, overrideRank, pendingChampionPoints)
    if(DoesAbilityExist(abilityId)) then
        local hasProgression, progressionIndex, lastRankXP, nextRankXP, currentXP, atMorph = GetAbilityProgressionXPInfoFromAbilityId(abilityId)
        self:AddAbilityName(abilityId, hideRank, overrideRank)
        if(hasProgression) then
            self:AddAbilityProgressBar(currentXP, lastRankXP, nextRankXP, atMorph)
        end
        if(not IsAbilityPassive(abilityId)) then
            self:AddAbilityStats(abilityId)
        end
        self:AddAbilityDescription(abilityId, pendingChampionPoints)
    end
end
function ZO_Tooltip:LayoutSkillLineAbility(skillType, skillLineIndex, abilityIndex, showNextUpgrade, hideRank, overrideRank, showPurchaseInfo)
    local abilityId = GetSkillAbilityId(skillType, skillLineIndex, abilityIndex, showNextUpgrade)
    self:LayoutAbility(abilityId, hideRank, overrideRank)
    if(showPurchaseInfo) then
        --Purchase Information
        local hasProgression, progressionIndex, lastRankXP, nextRankXP, currentXP, atMorph = GetAbilityProgressionXPInfoFromAbilityId(abilityId)
        local name, icon, earnedRank, passive, ultimate, purchased, progressionIndex = GetSkillAbilityInfo(skillType, skillLineIndex, abilityIndex)
        if(purchased and hasProgression and atMorph) then
            local morphSection = self:AcquireSection(self:GetStyle("bodySection"))
            morphSection:AddLine(GetString(SI_ABILITY_AT_MORPH_POINT), self:GetStyle("abilityUpgrade"), self:GetStyle("bodyDescription"))
            self:AddSection(morphSection)
        elseif(not purchased) then
            local skillLineName, skillLineRank = GetSkillLineInfo(skillType, skillLineIndex)
            local purchaseInfoSection = self:AcquireSection(self:GetStyle("bodySection"))
            if(skillLineRank < earnedRank) then
                purchaseInfoSection:AddLine(zo_strformat(SI_ABILITY_UNLOCKED_AT, skillLineName, earnedRank), self:GetStyle("failed"), self:GetStyle("bodyDescription"))
            elseif(GetAvailableSkillPoints() == 0) then
                purchaseInfoSection:AddLine(GetString(SI_ABILITY_PURCHASE), self:GetStyle("failed"), self:GetStyle("bodyDescription"))
            else
                purchaseInfoSection:AddLine(GetString(SI_ABILITY_PURCHASE), self:GetStyle("succeeded"), self:GetStyle("bodyDescription"))
            end
            self:AddSection(purchaseInfoSection)
        elseif(passive) then
            local currentUpgradeLevel, maxUpgradeLevel = GetSkillAbilityUpgradeInfo(skillType, skillLineIndex, abilityIndex)
            if(currentUpgradeLevel and maxUpgradeLevel and currentUpgradeLevel < maxUpgradeLevel) then
                local skillLineName, skillLineRank = GetSkillLineInfo(skillType, skillLineIndex)
                local _, _, nextUpgradeEarnedRank = GetSkillAbilityNextUpgradeInfo(skillType, skillLineIndex, abilityIndex)
                local purchaseInfoSection = self:AcquireSection(self:GetStyle("bodySection"))
                if(skillLineRank < nextUpgradeEarnedRank) then
                    purchaseInfoSection:AddLine(zo_strformat(SI_SKILL_ABILITY_TOOLTIP_UPGRADE_UNLOCK_INFO, skillLineName, nextUpgradeEarnedRank), self:GetStyle("failed"), self:GetStyle("bodyDescription"))
                elseif(GetAvailableSkillPoints() == 0) then
                    purchaseInfoSection:AddLine(GetString(SI_ABILITY_UPGRADE), self:GetStyle("failed"), self:GetStyle("bodyDescription"))
                else
                    purchaseInfoSection:AddLine(GetString(SI_ABILITY_UPGRADE), self:GetStyle("succeeded"), self:GetStyle("bodyDescription"))
                end
                self:AddSection(purchaseInfoSection)
            end
        end
    end
end
function ZO_Tooltip:LayoutAbilityMorph(progressionIndex, morphIndex)
    local RANK = 1
    local abilityId = GetAbilityProgressionAbilityId(progressionIndex, morphIndex, RANK)
    self:LayoutAbility(abilityId)
end
function ZO_Tooltip:LayoutActionBarAbility(slotId)
    local slotType = GetSlotType(slotId)
    if slotType == ACTION_TYPE_ABILITY then
        self:LayoutAbility(GetSlotBoundId(slotId))
    end
end
function ZO_Tooltip:LayoutChampionSkillAbility(disciplineIndex, skillIndex, pendingPoints)
    local abilityId = GetChampionAbilityId(disciplineIndex, skillIndex)
    
    local HIDE_RANK = true
    local OVERRIDE_RANK = nil
    self:LayoutAbility(abilityId, HIDE_RANK, OVERRIDE_RANK, pendingPoints)
    local unlockLevel = GetChampionSkillUnlockLevel(disciplineIndex, skillIndex)
    if unlockLevel ~= nil then
        local pointsSpent = GetNumPointsSpentInChampionDiscipline(disciplineIndex)
        local unlockSection = self:AcquireSection(self:GetStyle("bodySection"))
        local unlockText
        local textColor
        if pointsSpent + pendingPoints < unlockLevel then
            unlockText = SI_CHAMPION_TOOLTIP_LOCKED
            textColor = self:GetStyle("failed")
        else
            unlockText = SI_CHAMPION_TOOLTIP_UNLOCKED
            textColor = self:GetStyle("succeeded")
        end
        unlockSection:AddLine(zo_strformat(unlockText, GetChampionDisciplineName(disciplineIndex), unlockLevel), self:GetStyle("bodyDescription"), textColor)
        self:AddSection(unlockSection)
    else
        --if it's possible to spend more points on this skill (we haven't hit cap)
        if GetNumPointsSpentOnChampionSkill(disciplineIndex, skillIndex) + pendingPoints < GetMaxPossiblePointsInChampionSkill() then
            local upgradeSection = self:AcquireSection(self:GetStyle("bodySection"))
            local nextPointDescription = GetChampionAbilityDescription(abilityId, pendingPoints + 1)
            if nextPointDescription ~= "" then
                upgradeSection:AddLine(GetString(SI_CHAMPION_TOOLTIP_NEXT_POINT), self:GetStyle("abilityUpgrade"), self:GetStyle("bodyHeader"))
                upgradeSection:AddLine(zo_strformat(SI_ABILITY_TOOLTIP_DESCRIPTION, nextPointDescription), self:GetStyle("abilityUpgrade"), self:GetStyle("bodyDescription"))
                self:AddSection(upgradeSection)
            end
            local attribute = GetChampionDisciplineAttribute(disciplineIndex)
            local availablePoints = GetNumUnspentChampionPoints(attribute)
            local iconPath = GetChampionPointAttributeIcon(attribute)
            local pointCostSection = self:AcquireSection(self:GetStyle("bodySection"))
            if availablePoints > pendingPoints then
                pointCostSection:AddLine(zo_strformat(SI_CHAMPION_TOOLTIP_UPGRADE, iconPath), self:GetStyle("bodyDescription"), self:GetStyle("succeeded"))
            else
                pointCostSection:AddLine(zo_strformat(SI_CHAMPION_TOOLTIP_POINTS_REQUIRED, iconPath), self:GetStyle("bodyDescription"), self:GetStyle("failed"))
            end
            self:AddSection(pointCostSection)
        end
    end
end