Back to Home

ESO Lua File v101043

ingame/guild/zo_guildranks_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
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
--Guild Rank
----------------
ZO_GuildRank_Shared = ZO_Object:Subclass()
function ZO_GuildRank_Shared:New(guildRanksObject, guildId, index, customName)
    local rank = ZO_Object.New(self)
    rank.guildId = guildId
    rank.index = index
    rank.guildRanksObject = guildRanksObject
    rank.permissionSet = {}
    if rank:IsNewRank() then
        rank.id = guildRanksObject:GetUniqueRankId()
        rank.name = customName
        rank.hasCustomName = true
        rank.iconIndex = guildRanksObject:GetUnusedIconIndex()
        for i = GUILD_PERMISSION_ITERATION_BEGIN, GUILD_PERMISSION_ITERATION_END do
            rank.permissionSet[i] = false
        end
    else
        rank.id = GetGuildRankId(guildId, index)
        rank.name = GetFinalGuildRankName(guildId, index)
        rank.hasCustomName = GetGuildRankCustomName(guildId, index) ~= ""
        rank.iconIndex = GetGuildRankIconIndex(guildId, index)
        for i = GUILD_PERMISSION_ITERATION_BEGIN, GUILD_PERMISSION_ITERATION_END do
            rank.permissionSet[i] = DoesGuildRankHavePermission(guildId, index, i)
        end
    end
    rank.lastGoodName = rank.name
    return rank
end
function ZO_GuildRank_Shared:SetName(name)
    if name ~= self.name then
        self.name = name
        local defaultName = GetDefaultGuildRankName(self.guildId, self.index)
        if defaultName ~= "" then
            if defaultName == name then
                self.hasCustomName = false
            else
                self.hasCustomName = true
            end
        else
            self.hasCustomName = true
        end
    end
end
function ZO_GuildRank_Shared:GetName()
    return self.name
end
function ZO_GuildRank_Shared:GetRankId()
    return self.id
end
function ZO_GuildRank_Shared:GetIconIndex()
    return self.iconIndex
end
function ZO_GuildRank_Shared:SetIconIndex(index)
    self.iconIndex = index
end
function ZO_GuildRank_Shared:GetSmallIcon()
    return GetGuildRankSmallIcon(self.iconIndex)
end
function ZO_GuildRank_Shared:GetLargeIcon()
    return GetGuildRankLargeIcon(self.iconIndex)
end
function ZO_GuildRank_Shared:IsPermissionSet(permission)
    return self.permissionSet[permission]
end
function ZO_GuildRank_Shared:SetPermission(permission, enabled)
    self.permissionSet[permission] = enabled
    if enabled then
        local numDependencies = GetNumGuildPermissionDependencies(permission)
        for i = 1, numDependencies do
            local dependency = GetGuildPermissionDependency(permission, i)
            if dependency >= GUILD_PERMISSION_ITERATION_BEGIN and dependency <= GUILD_PERMISSION_ITERATION_END then
                self:SetPermission(dependency, enabled)
            end
        end
    end
    -- make sure the view gold permission and the bank history permissions are all set to the same value
    if permission == GUILD_PERMISSION_BANK_VIEW_GOLD then
        self.permissionSet[GUILD_PERMISSION_BANK_VIEW_WITHDRAW_HISTORY] = enabled
        self.permissionSet[GUILD_PERMISSION_BANK_VIEW_DEPOSIT_HISTORY] = enabled
    end
end
function ZO_GuildRank_Shared:GetPermissions()
    local permissions = 0
    for i = 1, #self.permissionSet do
        permissions = ComposeGuildRankPermissions(permissions, i, self.permissionSet[i])
    end
    return permissions
end
function ZO_GuildRank_Shared:GetSaveName()
    --we only save custom names
    if self.hasCustomName then
        return self.name
    else
        return ""
    end
end
function ZO_GuildRank_Shared:IsNewRank()
    if self.index == nil then
        return true
    end
end
function ZO_GuildRank_Shared:NeedsSave()
    if self:IsNewRank() then
        return true
    end
    if self.iconIndex ~= GetGuildRankIconIndex(self.guildId, self.index) then
        return true
    end
    for i = GUILD_PERMISSION_ITERATION_BEGIN, GUILD_PERMISSION_ITERATION_END do
        if self.permissionSet[i] ~= DoesGuildRankHavePermission(self.guildId, self.index, i) then
            return true
        end
    end
    if self.hasCustomName then
        if self.name ~= GetGuildRankCustomName(self.guildId, self.index) then
            return true
        end
    else
        if GetGuildRankCustomName(self.guildId, self.index) ~= "" then
            return true
        end
    end
    return false
end
function ZO_GuildRank_Shared:CopyPermissionsFrom(copyRank)
    ZO_ClearNumericallyIndexedTable(self.permissionSet)
    for i = GUILD_PERMISSION_ITERATION_BEGIN, GUILD_PERMISSION_ITERATION_END do
        self.permissionSet[i] = copyRank.permissionSet[i]
    end
end
function ZO_GuildRank_Shared:Save()
end
---------------
--Guild Ranks--
---------------
ZO_GuildRanks_Shared = ZO_Object:Subclass()
function ZO_GuildRanks_Shared:New(...)
    local object = ZO_Object.New(self)
    ZO_GuildRanks_Shared.Initialize(object, ...)
    return object
end
function ZO_GuildRanks_Shared:Initialize(control, templateData)
    self.control = control
    self.ranks = {}
    -- This is platform specific data that needs to be overridden by the inheriting classes as it
    -- specifies the platform specific data to use.
    --[[ Expected Attributes for Permissions
gridListClass - The class object from which self.permissionsGridList will be created,
entryTemplate - The name of the template control to be used for the permission checkbox entry,
entryWidth - The width to be used for the the entryTemplate,
entryHeight - The height to be used for the entryTemplate,
headerTemplate - The name of the template control to be used for the permissions category header entry,
headerHeight - The height to be used for the headerTemplate,
highlightTemplate - Optional: highlight override template used for Gamepad (needed since checkboxes highlight the checkbox instead of the full control which is the default),
narrationText -- Optional: The text used to narrate the entry when using screen narration. Can be a function or a string
]]
    self.templateData = templateData
end
function ZO_GuildRanks_Shared:InitializePermissionsGridListControl()
    assert(false) -- override in derived function
end
function ZO_GuildRanks_Shared:GetSelectedRank()
    assert(false) -- override in derived function
end
function ZO_GuildRanks_Shared:InitializePermissionsGridList()
    local templateData = self.templateData
    -- Override default highlight template to hide white outline around tiles
    self.permissionsGridList = templateData.gridListClass:New(self.permissionsGridListControl, templateData.highlightTemplate)
    local NO_HIDE_CALLBACK = nil
    local GRID_PADDING = 0
    self.permissionsGridList:AddEntryTemplate(templateData.entryTemplate, templateData.entryWidth, templateData.entryHeight, ZO_DefaultGridTileEntrySetup, NO_HIDE_CALLBACK, ZO_DefaultGridTileEntryReset, GRID_PADDING, GRID_PADDING)
    self.permissionsGridList:AddHeaderTemplate(templateData.headerTemplate, templateData.headerHeight, ZO_DefaultGridTileHeaderSetup)
end
function ZO_GuildRanks_Shared:OnPermissionGridListEntryToggle()
    assert(false) -- override in derived function
end
function ZO_GuildRanks_Shared:CreatePermissionDataObject(index, permission)
    local data =
    {
        index = index,
        value = permission,
        text = GetString("SI_GUILDPERMISSION", permission),
        clickSound = SOUNDS.GUILD_RANK_PERMISSION_TOGGLE,
        onToggleFunction = function(...)
            return self:OnPermissionGridListEntryToggle(...)
        end,
        isChecked = function()
            local selectedRank = self:GetSelectedRank()
            return selectedRank and selectedRank:IsPermissionSet(permission) or false
        end,
        isDisabled = function()
            local selectedRank = self:GetSelectedRank()
            if selectedRank then
                local canPlayerEditPermissions = DoesPlayerHaveGuildPermission(self.guildId, GUILD_PERMISSION_PERMISSION_EDIT)
                local canEditRankPermissions = CanEditGuildRankPermission(selectedRank.id, permission)
                local disabledByRequisitePermissions = GetNumGuildPermissionRequisites(permission) > 0 and ZO_GuildRanks_Shared.AreAnyRequisitePermissionsEnabled(permission, selectedRank)
                return not canPlayerEditPermissions or not canEditRankPermissions or disabledByRequisitePermissions
            end
            return false
        end,
        narrationText = self.templateData.narrationText,
    }
    return data
end
function ZO_GuildRanks_Shared:BuildPermissionsGridList()
    self.permissionsGridList:ClearGridList()
    local templateData = self.templateData
    for categoryIndex, category in pairs(GUILD_RANKS_MANAGER:GetPermissionsLayout()) do
        for i, permission in ipairs(category.permissions) do
            local data = self:CreatePermissionDataObject(i, permission)
            data.gridHeaderName = category.header
            data.gridHeaderTemplate = templateData.headerTemplate
            self.permissionsGridList:AddEntry(data, templateData.entryTemplate)
        end
    end
    self.permissionsGridList:CommitGridList()
end
function ZO_GuildRanks_Shared:SetGuildId(guildId)
    self.guildId = guildId
end
function ZO_GuildRanks_Shared:CancelDialog()
end
function ZO_GuildRanks_Shared:ShowAddRankDialog(dialogName)
    ZO_Dialogs_ShowDialog(dialogName)
end
function ZO_GuildRanks_Shared:InitializeAddRankDialog(dialogName)
    local control = ZO_GuildAddRankDialog
    ZO_Dialogs_RegisterCustomDialog(dialogName,
    {
        setup = function(dialog)
            dialog:GetNamedChild("NameEdit"):SetText("")
            dialog.copyComboBox:ClearItems()
            local noneEntry = dialog.copyComboBox:CreateItemEntry(GetString(SI_GUILD_RANKS_COPY_NONE), dialog.copyComboBox.OnRankSelected)
            dialog.copyComboBox:AddItem(noneEntry)
            --Skip Guild Master
            for i = 2, #self.ranks do
                local entry = dialog.copyComboBox:CreateItemEntry(self.ranks[i].name, dialog.copyComboBox.OnRankSelected)
                entry.rankIndex = i
                dialog.copyComboBox:AddItem(entry)
            end
            dialog.copyComboBox:SetSelectedItemText(GetString(SI_GUILD_RANKS_COPY_NONE))
            dialog.copyComboBox.selectedRankIndex = nil
        end,
        customControl = control,
        title =
        {
            text = SI_GUILD_RANKS_ADD_RANK,
        },
        buttons =
        {
            [1] =
            {
                control = GetControl(control, "Add"),
                text = SI_DIALOG_CREATE,
                callback = function(dialog)
                    local rankName = dialog:GetNamedChild("NameEdit"):GetText()
                    self:AddRank(rankName, dialog.copyComboBox.selectedRankIndex)
                end,
            },
            [2] =
            {
                control = GetControl(control, "Cancel"),
                text = SI_DIALOG_CANCEL,
                callback = function()
                    self:CancelDialog()
                end,
            }
        }
    })
    local nameEdit = control:GetNamedChild("NameEdit")
    nameEdit:SetMaxInputChars(MAX_GUILD_RANK_NAME_LENGTH)
    local addRankFields = ZO_RequiredTextFields:New()
    addRankFields:AddButton(control:GetNamedChild("Add"))
    addRankFields:AddTextField(nameEdit)
    control.copyComboBox = ZO_ComboBox_ObjectFromContainer(control:GetNamedChild("CopyPermissions"))
    control.copyComboBox:SetSortsItems(false)
    control.copyComboBox.OnRankSelected = function(comboBox, entryText, entry)
        comboBox.selectedRankIndex = entry.rankIndex
    end
end
function ZO_GuildRanks_Shared:Save()
    if self.ranks ~= nil and self.guildId ~= nil and #self.ranks > 0 then
        InitializePendingGuildRanks(self.guildId)
        for i = 1, #self.ranks do
            local rank = self.ranks[i]
            rank:Save()
        end
        return SavePendingGuildRanks()
    end
    return false
end
do
    local MAX_RANK_IDS = 255
    function ZO_GuildRanks_Shared:GetUniqueRankId()
        for rankId = 1, MAX_RANK_IDS do
            local idExists = false
            for i = 1, #self.ranks do
                if rankId == self.ranks[i].id then
                    idExists = true
                    break
                end
            end
            if not idExists then
                return rankId
            end
        end
    end
end
function ZO_GuildRanks_Shared:GetUnusedIconIndex()
    local iconIndex = 0
    local foundUnusedIconIndex = false
    while not foundUnusedIconIndex and iconIndex < GetNumGuildRankIcons() do
        iconIndex = iconIndex + 1
        for i = 1, #self.ranks do
            local rank = self.ranks[i]
            if rank.iconIndex == iconIndex then
                break
            end
        end
    end
    return iconIndex
end
function ZO_GuildRanks_Shared:IsRankOccupied(selectedRank)
    local rankOccupied = false
    if not selectedRank:IsNewRank() then
        for guildMemberIndex = 1, GetNumGuildMembers(self.guildId) do
            local _, _, rankIndex = GetGuildMemberInfo(self.guildId, guildMemberIndex)
            if rankIndex == selectedRank.index then
                rankOccupied = true
                break
            end
        end
    end
    return rankOccupied
end
function ZO_GuildRanks_Shared:MatchesGuild(guildId)
    return guildId == self.guildId
end
function ZO_GuildRanks_Shared:NeedsSave()
    local needsSave = false
    local numRanks = #self.ranks
    local numPrevRanks = GetNumGuildRanks(self.guildId)
    if numRanks ~= numPrevRanks then
        return true
    end
    for i = 1, numRanks do
        local rank = self.ranks[i]
        if rank:NeedsSave() then
            needsSave = true
            break
        end
        if i ~= rank.index then
            needsSave = true
            break
        end
    end
    return needsSave
end
function ZO_GuildRanks_Shared:InsertRank(newRank, copyPermissionsFromRankIndex)
    local insertionPoint = #self.ranks + 1
    if copyPermissionsFromRankIndex ~= nil then
        local copyRank = self.ranks[copyPermissionsFromRankIndex]
        newRank:CopyPermissionsFrom(copyRank)
        insertionPoint = copyPermissionsFromRankIndex + 1
    end
    table.insert(self.ranks, insertionPoint, newRank)
    PlaySound(SOUNDS.GUILD_RANK_CREATED)
    return insertionPoint
end
function ZO_GuildRanks_Shared:GetRankById(rankId)
    if rankId ~= nil then
        for i = 1, #self.ranks do
            local rank = self.ranks[i]
            if rank.id == rankId then
                return rank, i
            end
        end
    end
end
function ZO_GuildRanks_Shared:GetRankIndexById(rankId)
    local rank, index = self:GetRankById(rankId)
    return index
end
function ZO_GuildRanks_Shared.AreAnyRequisitePermissionsEnabled(dependencyPermission, rank)
    local numRequisitePermissions = GetNumGuildPermissionRequisites(dependencyPermission)
    for i = 1, numRequisitePermissions do
        local requisitePermission = GetGuildPermissionRequisite(dependencyPermission, i)
        if rank:IsPermissionSet(requisitePermission) then
            return true
        end
    end
    return false
end
do
    local PERMISSION_INFO =
    {
        [GUILD_PERMISSION_GUILD_KIOSK_BID] = zo_strformat(SI_GUILD_PERMISSION_INFO_ONE_DEPENDENCY, GetString("SI_GUILDPERMISSION", GUILD_PERMISSION_BANK_VIEW_GOLD)) .. "\n\n" .. GetString(SI_GUILD_PERMISSION_INFO_GUILD_KIOSK_BID),
        [GUILD_PERMISSION_BANK_WITHDRAW_GOLD] = zo_strformat(SI_GUILD_PERMISSION_INFO_ONE_DEPENDENCY, GetString("SI_GUILDPERMISSION", GUILD_PERMISSION_BANK_VIEW_GOLD)),
        [GUILD_PERMISSION_BANK_VIEW_GOLD] = GetString(SI_GUILD_PERMISSION_INFO_BANK_VIEW_GOLD),
        [GUILD_PERMISSION_MANAGE_BLACKLIST] = zo_strformat(SI_GUILD_PERMISSION_INFO_ONE_DEPENDENCY, GetString("SI_GUILDPERMISSION", GUILD_PERMISSION_REMOVE)),
        [GUILD_PERMISSION_MANAGE_APPLICATIONS] = zo_strformat(SI_GUILD_PERMISSION_INFO_ONE_DEPENDENCY, GetString("SI_GUILDPERMISSION", GUILD_PERMISSION_INVITE)),
    }
    function ZO_GuildRanks_Shared.GetToolTipInfoForPermission(permission)
        return PERMISSION_INFO[permission]
    end
end