UESP:ESO Lua File v101050 -- publicallingames/tooltip/tributetooltips.lua

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

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

-- optionalDockCardUpgradeContext should be a table from ZO_TributePatronData:GetDockCards

function ZO_Tooltip:LayoutTributeCard(cardData, optionalDockCardUpgradeContext)

local patronData = TRIBUTE_DATA_MANAGER:GetTributePatronData(cardData:GetPatronDefId())

local isContract = cardData:IsContract()

local isCurse = cardData:IsCurse()

-- Header

local topSection = self:AcquireSection(self:GetStyle("collectionsTopSection"))

local cardTypeString = GetString("SI_TRIBUTECARDTYPE", cardData:GetCardType())

if isContract then

topSection:AddLine(zo_strformat(SI_TRIBUTE_CARD_TYPE_CONTRACT, cardTypeString))

elseif isCurse then

topSection:AddLine(zo_strformat(SI_TRIBUTE_CARD_TYPE_CURSE, cardTypeString))

else

topSection:AddLine(zo_strformat(SI_TRIBUTE_CARD_TYPE_FORMATTER, cardTypeString))

end

if not isCurse then

topSection:AddLine(patronData:GetFormattedNameAndSuitIcon())

end

topSection:AddLine(GetString(SI_TRIBUTE_CARD_ITEM_TYPE))

self:AddSection(topSection)

-- Title

local titleSection = self:AcquireSection(self:GetStyle("title"))

local itemDisplayQuality = cardData:GetRarity()

local qualityColor = GetItemQualityColor(itemDisplayQuality)

titleSection:AddLine(cardData:GetFormattedName(), { fontColor = qualityColor })

local costResourceType, acquireCost = cardData:GetAcquireCost()

if acquireCost > 0 then

local acquirePair = titleSection:AcquireStatValuePair(self:GetStyle("statValuePair"))

acquirePair:SetStat(GetString("SI_TRIBUTERESOURCE_ACQUIRE", costResourceType), self:GetStyle("statValuePairStat"))

acquirePair:SetValue(acquireCost, self:GetStyle("statValuePairValue"))

titleSection:AddStatValuePair(acquirePair)

end

local defeatResourceType, defeatCost = cardData:GetDefeatCost()

if defeatCost > 0 then

local defeatPair = titleSection:AcquireStatValuePair(self:GetStyle("statValuePair"))

defeatPair:SetStat(GetString("SI_TRIBUTERESOURCE_DEFEAT", defeatResourceType), self:GetStyle("statValuePairStat"))

defeatPair:SetValue(defeatCost, self:GetStyle("statValuePairValue"))

titleSection:AddStatValuePair(defeatPair)

end

self:AddSection(titleSection)

-- Activation Mechanics

-- Even when there are no activation effects, add the header, cause we'll put a line saying there are no activation effects

local activationSection = self:AcquireSection(self:GetStyle("bodySection"))

local triggerSection = nil

activationSection:AddLine(GetString(SI_TRIBUTE_CARD_PLAY_EFFECT), self:GetStyle("bodyHeader"))

local ON_ACTIVATION = TRIBUTE_MECHANIC_ACTIVATION_SOURCE_ACTIVATION

local numMechanics = cardData:GetNumMechanics(ON_ACTIVATION)

if numMechanics > 0 then

local hasNonTriggerMechanics = false

local triggerMechanics = {}

if cardData:DoesChooseOneMechanic() then

activationSection:AddLine(GetString(SI_TRIBUTE_CARD_CHOOSE_ONE_MECHANIC), self:GetStyle("tributeBodyText"), self:GetStyle("tributeChooseOneText"))

end

local PREPEND_ICON = true

for index = 1, numMechanics do

local triggerId = select(7, cardData:GetMechanicInfo(ON_ACTIVATION, index))

if triggerId ~= 0 then

local triggerMechanicData =

{

index = index,

id = triggerId,

}

table.insert(triggerMechanics, triggerMechanicData)

else

local mechanicText = cardData:GetMechanicText(ON_ACTIVATION, index, PREPEND_ICON)

activationSection:AddLine(mechanicText, self:GetStyle("tributeBodyText"))

hasNonTriggerMechanics = true

end

if not hasNonTriggerMechanics then

activationSection:AddLine(GetString(SI_TRIBUTE_CARD_NO_PLAY_EFFECT_DESCRIPTION), self:GetStyle("tributeBodyText"))

end

if #triggerMechanics > 0 then

triggerSection = self:AcquireSection(self:GetStyle("bodySection"))

triggerSection:AddLine(GetString(SI_TRIBUTE_CARD_TRIGGER_EFFECT_HEADER), self:GetStyle("bodyHeader"))

for _, triggerMechanic in ipairs(triggerMechanics) do

local triggerText = GetTributeTriggerDescription(triggerMechanic.id)

triggerSection:AddLine(triggerText, self:GetStyle("tributeBodyText"))

local mechanicText = cardData:GetMechanicText(ON_ACTIVATION, triggerMechanic.index, PREPEND_ICON)

triggerSection:AddLine(mechanicText, self:GetStyle("tributeBodyText"))

end

else

activationSection:AddLine(GetString(SI_TRIBUTE_CARD_NO_PLAY_EFFECT_DESCRIPTION), self:GetStyle("tributeBodyText"))

end

self:AddSection(activationSection)

if triggerSection then

self:AddSection(triggerSection)

end

-- Combo mechanics

local ON_COMBO = TRIBUTE_MECHANIC_ACTIVATION_SOURCE_COMBO

local numMechanics = cardData:GetNumMechanics(ON_COMBO)

if numMechanics > 0 then

local comboSection = nil

-- We technically only support combo 2, combo 3, and combo 4 right now. Any more requires a different visual solution on the card itself.

-- That said, it makes no real difference to support an arbitrarily higher number here to remain somewhat flexible for future designs

-- since we'll stop as soon as we've processed every mechanic anyway

local MIN_COMBO_NUM = 2

local MAX_COMBO_NUM = 10

local PREPEND_ICON = true

local mechanicsProcessed = 0

for currentComboNum = MIN_COMBO_NUM, MAX_COMBO_NUM do

local isHeaderShown = false

for comboMechanicIndex = 1, numMechanics do

local mechanicComboNum = select(3, cardData:GetMechanicInfo(ON_COMBO, comboMechanicIndex))

if currentComboNum == mechanicComboNum then

if not isHeaderShown then

local headerText = zo_strformat(SI_TRIBUTE_CARD_COMBO_EFFECT, currentComboNum)

if comboSection then

self:AddSection(comboSection)

end

comboSection = self:AcquireSection(self:GetStyle("bodySection"))

comboSection:AddLine(headerText, self:GetStyle("bodyHeader"))

isHeaderShown = true

end

local mechanicText = cardData:GetMechanicText(ON_COMBO, comboMechanicIndex, PREPEND_ICON)

comboSection:AddLine(mechanicText, self:GetStyle("tributeBodyText"))

mechanicsProcessed = mechanicsProcessed + 1

if mechanicsProcessed == numMechanics then

self:AddSection(comboSection)

break

end

if mechanicsProcessed == numMechanics then

break

end

-- Flags

if cardData:DoesTaunt() then

local section = self:AcquireSection(self:GetStyle("bodySection"))

section:AddLine(GetString(SI_TRIBUTE_CARD_TAUNT_TITLE), self:GetStyle("bodyHeader"))

section:AddLine(GetString(SI_TRIBUTE_CARD_TAUNT_DESCRIPTION), self:GetStyle("tributeBodyText"))

self:AddSection(section)

end

if isContract then

local section = self:AcquireSection(self:GetStyle("bodySection"))

section:AddLine(GetString(SI_TRIBUTE_CARD_CONTRACT_DESCRIPTION), self:GetStyle("tributeBodyText"))

self:AddSection(section)

elseif isCurse then

local section = self:AcquireSection(self:GetStyle("bodySection"))

section:AddLine(GetString(SI_TRIBUTE_CARD_CURSE_DESCRIPTION), self:GetStyle("tributeBodyText"))

self:AddSection(section)

end

-- Flavor Text

local flavorText = cardData:GetFlavorText()

if flavorText ~= "" then

local section = self:AcquireSection(self:GetStyle("bodySection"))

section:AddLine(zo_strformat(GetString(SI_TRIBUTE_CARD_TEXT_FORMATTER), cardData:GetFlavorText()), self:GetStyle("tributeBodyText"))

self:AddSection(section)

end

-- Upgrade Information

-- If the context has an upgradesTo, that means it's a base card, it has an upgrade, and we do not currently have the upgrade unlocked

if optionalDockCardUpgradeContext and optionalDockCardUpgradeContext.upgradesTo then

local section = self:AcquireSection(self:GetStyle("bodySection"))

local upgradesToCardData = ZO_TributeCardData:New(cardData:GetPatronDefId(), optionalDockCardUpgradeContext.upgradesTo)

section:AddLine(GetString(SI_TRIBUTE_PATRON_UPGRADE_TITLE), self:GetStyle("bodyHeader"))

section:AddLine(zo_strformat(GetString(SI_TRIBUTE_CARD_AVAILABLE_UPGRADE_FORMATTER), cardData:GetColorizedName(), upgradesToCardData:GetColorizedName()), self:GetStyle("tributeBodyText"))

section:AddLine(GetTributeCardUpgradeHintText(cardData:GetPatronDefId(), optionalDockCardUpgradeContext.cardIndex), self:GetStyle("tributeBodyText"))

self:AddSection(section)

end

function ZO_Tooltip:LayoutTributePatronFavorStateInfo(patronData, favorState, useDesaturatedText)

local requirementsText = patronData:GetRequirementsText(favorState)

local mechanicsText = patronData:GetMechanicsText(favorState)

local numPassiveMechanics = patronData:GetNumPassiveMechanicsForFavorState(favorState)

local showActivationText = requirementsText ~= "" and mechanicsText ~= ""

if showActivationText or numPassiveMechanics > 0 then

local favorSection = self:AcquireSection(self:GetStyle("bodySection"))

--Layout the title of the favor state

local favorText = GetString("SI_TRIBUTEPATRONPERSPECTIVEFAVORSTATE", favorState)

local colorStyle = useDesaturatedText and self:GetStyle("tributeDisabledMechanicText") or nil

if favorState == TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_FAVORS_PLAYER then

favorSection:AddLine(favorText, colorStyle or self:GetStyle("succeeded"), self:GetStyle("bodyHeader"))

elseif favorState == TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_NEUTRAL then

favorSection:AddLine(favorText, colorStyle, self:GetStyle("bodyHeader"))

elseif favorState == TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_FAVORS_OPPONENT then

favorSection:AddLine(favorText, colorStyle or self:GetStyle("failed"), self:GetStyle("bodyHeader"))

else

internalassert(false, "Unsupported Favor State")

end

local passiveFormatterStringId = useDesaturatedText and SI_TRIBUTE_PATRON_TOOLTIP_PASSIVE_MECHANIC_DISABLED_FORMATTER or SI_TRIBUTE_PATRON_TOOLTIP_PASSIVE_MECHANIC_FORMATTER

for mechanicIndex = 1, numPassiveMechanics do

local triggerId = select(6, patronData:GetPassiveMechanicInfo(favorState, mechanicIndex))

local triggerText = GetTributeTriggerDescription(triggerId)

local mechanicText = patronData:GetPassiveMechanicText(favorState, mechanicIndex)

favorSection:AddLine(zo_strformat(GetString(passiveFormatterStringId), triggerText, mechanicText), colorStyle or self:GetStyle("whiteFontColor"), self:GetStyle("bodyDescription"))

end

if showActivationText then

local resultText = ""

--Do not include the result string for neutral patrons

if not patronData:IsNeutral() then

local displayFavorState = favorState

if patronData:DoesSkipNeutralFavorState() and favorState == TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_FAVORS_OPPONENT then

displayFavorState = TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_NEUTRAL

end

resultText = GetString("SI_TRIBUTEPATRONPERSPECTIVEFAVORSTATE_RESULT", displayFavorState)

end

local formatterStringId = useDesaturatedText and SI_TRIBUTE_PATRON_TOOLTIP_FAVOR_DESCRIPTION_DISABLED_FORMATTER or SI_TRIBUTE_PATRON_TOOLTIP_FAVOR_DESCRIPTION_FORMATTER

favorSection:AddLine(zo_strformat(GetString(formatterStringId), requirementsText, mechanicsText, resultText), colorStyle or self:GetStyle("whiteFontColor"), self:GetStyle("bodyDescription"))

end

self:AddSection(favorSection)

end

function ZO_Tooltip:LayoutTributePatron(patronData, optionalArgs)

local highlightActivePatronState = optionalArgs and optionalArgs.highlightActivePatronState or false

local suppressNotCollectibleWarning = optionalArgs and optionalArgs.suppressNotCollectibleWarning or false

local showAcquireHint = optionalArgs and optionalArgs.showAcquireHint or false

local showLore = optionalArgs and optionalArgs.showLore or false

local overrideFavorState = optionalArgs and optionalArgs.overrideFavorState

-- Header

local topSection = self:AcquireSection(self:GetStyle("collectionsTopSection"))

topSection:AddLine(GetString(SI_TRIBUTE_PATRON_TYPE))

local collectionId = patronData:GetPatronCollectibleId()

if patronData:IsNeutral() then

topSection:AddLine(GetString("SI_TRIBUTEPATRONPERSPECTIVEFAVORSTATE", TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_NEUTRAL))

else

--Neutral patrons should never be collectible

if collectionId ~= 0 then

topSection:AddLine(GetString("SI_COLLECTIBLEUNLOCKSTATE", GetCollectibleUnlockStateById(collectionId)))

end

self:AddSection(topSection)

-- Title

local titleSection = self:AcquireSection(self:GetStyle("title"))

local itemDisplayQuality = patronData:GetRarity()

local qualityColor = GetItemQualityColor(itemDisplayQuality)

titleSection:AddLine(patronData:GetFormattedName(), { fontColor = qualityColor })

self:AddSection(titleSection)

local currentFavorState = nil

--If an override favor state was set, highlight that instead of the active favor state

if overrideFavorState then

currentFavorState = overrideFavorState

elseif highlightActivePatronState and TRIBUTE.GetGameFlowState and TRIBUTE:GetGameFlowState() ~= TRIBUTE_GAME_FLOW_STATE_INACTIVE then

-- Highlight the active Favor state only if requested and if a Tribute game is currently active.

local patronStall = TRIBUTE:GetPatronStallByPatronId(patronData:GetId())

if patronStall then

currentFavorState = patronStall:GetCurrentFavorState()

end

do

local useDesaturatedText

useDesaturatedText = currentFavorState and currentFavorState ~= TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_FAVORS_PLAYER or false

self:LayoutTributePatronFavorStateInfo(patronData, TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_FAVORS_PLAYER, useDesaturatedText)

useDesaturatedText = currentFavorState and currentFavorState ~= TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_NEUTRAL or false

self:LayoutTributePatronFavorStateInfo(patronData, TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_NEUTRAL, useDesaturatedText)

useDesaturatedText = currentFavorState and currentFavorState ~= TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_FAVORS_OPPONENT or false

self:LayoutTributePatronFavorStateInfo(patronData, TRIBUTE_PATRON_PERSPECTIVE_FAVOR_STATE_FAVORS_OPPONENT, useDesaturatedText)

end

-- Body

if showLore then

local loreDescription = patronData:GetLoreDescription()

if loreDescription ~= "" then

local loreSection = self:AcquireSection(self:GetStyle("bodySection"))

loreSection:AddLine(loreDescription, self:GetStyle("bodyDescription"))

self:AddSection(loreSection)

end

local collectibleSection = nil

if collectionId == 0 then

if not suppressNotCollectibleWarning then

collectibleSection = self:AcquireSection(self:GetStyle("bodySection"))

collectibleSection:AddLine(GetString(SI_TRIBUTE_PATRON_TOOLTIP_NO_COLLECTIBLE), self:GetStyle("bodyDescription"), self:GetStyle("failed"))

end

elseif showAcquireHint then

collectibleSection = self:AcquireSection(self:GetStyle("bodySection"))

collectibleSection:AddLine(patronData:GetTributePatronAcquireHint(), self:GetStyle("title"))

end

if collectibleSection then

self:AddSection(collectibleSection)

end

function ZO_Tooltip:LayoutTributeBoardLocationPatrons(boardLocationData)

if boardLocationData:GetNumCards() == 0 then

return

end

do

local titleSection = self:AcquireSection(self:GetStyle("title"))

local displayName = boardLocationData:GetName()

titleSection:AddLine(displayName)

self:AddSection(titleSection)

end

do

local patronsSection = self:AcquireSection(self:GetStyle("bodySection"))

local patronCardCountList = boardLocationData:GetPatronCardCountList()

for _, patronCardCountData in ipairs(patronCardCountList) do

local numCards = patronCardCountData.numCards

local patronSuitIcon = patronCardCountData.patronData:GetPatronSuitIcon()

local patronName = patronCardCountData.patronData:GetFormattedName()

patronsSection:AddLine(zo_strformat(GetString(SI_TRIBUTE_PATRON_NAME_WITH_COUNT_AND_SUIT_ICON_FORMATTER), numCards, patronSuitIcon, patronName), self:GetStyle("whiteFontColor"), self:GetStyle("bodyDescription"))

end

self:AddSection(patronsSection)

--If we are looking at either player's agent pile, we need to include any confined cards as well

local boardLocation = boardLocationData:GetBoardLocation()

if boardLocation == TRIBUTE_BOARD_LOCATION_PLAYER_BOARD_AGENT or boardLocation == TRIBUTE_BOARD_LOCATION_OPPONENT_BOARD_AGENT then

local confinedLocation = boardLocation == TRIBUTE_BOARD_LOCATION_PLAYER_BOARD_AGENT and TRIBUTE_BOARD_LOCATION_PLAYER_PRISON or TRIBUTE_BOARD_LOCATION_OPPONENT_PRISON

local numConfined = GetNumTributeCardsAtBoardLocation(confinedLocation)

if numConfined > 0 then

local confinedSection = self:AcquireSection(self:GetStyle("bodySection"))

confinedSection:AddLine(zo_strformat(GetString(SI_TRIBUTE_CONFINED_COUNT_FORMATTER), numConfined), self:GetStyle("whiteFontColor"), self:GetStyle("bodyDescription"))

self:AddSection(confinedSection)

end

function ZO_Tooltip:LayoutTributeResource(resource)

local titleSection = self:AcquireSection(self:GetStyle("title"))

titleSection:AddLine(zo_strformat(SI_TRIBUTE_RESOURCE_NAME_FORMATTER, GetString("SI_TRIBUTERESOURCE", resource)))

self:AddSection(titleSection)

local bodySection = self:AcquireSection(self:GetStyle("bodySection"))

bodySection:AddLine(GetString("SI_TRIBUTERESOURCE_TOOLTIP", resource), self:GetStyle("bodyDescription"))

self:AddSection(bodySection)

end

function ZO_Tooltip:LayoutTributeDiscardCounter()

local titleSection = self:AcquireSection(self:GetStyle("title"))

titleSection:AddLine(GetString(SI_TRIBUTE_DISCARD_COUNTER_TOOLTIP_TITLE))

self:AddSection(titleSection)

local bodySection = self:AcquireSection(self:GetStyle("bodySection"))

bodySection:AddLine(GetString(SI_TRIBUTE_DISCARD_COUNTER_TOOLTIP_DESCRIPTION), self:GetStyle("bodyDescription"))

self:AddSection(bodySection)

end

function ZO_Tooltip:LayoutTributePatronUsage()

local titleSection = self:AcquireSection(self:GetStyle("title"))

titleSection:AddLine(GetString(SI_TRIBUTE_PATRON_USAGE_COUNTER_TOOLTIP_TITLE))

self:AddSection(titleSection)

local bodySection = self:AcquireSection(self:GetStyle("bodySection"))

bodySection:AddLine(GetString(SI_TRIBUTE_PATRON_USAGE_COUNTER_TOOLTIP_DESCRIPTION), self:GetStyle("bodyDescription"))

self:AddSection(bodySection)

end