----------------- --Guild Roster ----------------- ZO_GuildRosterManager = ZO_SocialManager:Subclass() GUILD_MEMBER_DATA = 1 GUILD_ROSTER_ENTRY_SORT_KEYS = { ["displayName"] = { }, ["characterName"] = { }, ["status"] = { tiebreaker = "normalizedLogoffSort", isNumeric = true }, ["class"] = { tiebreaker = "displayName" }, ["formattedZone"] = { tiebreaker = "displayName" }, ["alliance"] = { tiebreaker = "displayName" }, ["championPoints"] = { tiebreaker = "displayName", isNumeric = true}, ["level"] = { tiebreaker = "championPoints", isNumeric = true }, ["rankIndex"] = { tiebreaker = "displayName", isNumeric = true }, ["normalizedLogoffSort"] = { tiebreaker = "displayName", isNumeric = true }, } local EVENT_NAMESPACE = "GuildRoster" function ZO_GuildRosterManager:New() local manager = ZO_SocialManager.New(self) manager:Initialize() return manager end function ZO_GuildRosterManager:Initialize() self.noteEditedFunction = function(displayName, note) local numGuildMembers = GetNumGuildMembers(self.guildId) for guildMemberIndex = 1, numGuildMembers do local currentDisplayName = GetGuildMemberInfo(self.guildId, guildMemberIndex) if currentDisplayName == displayName then SetGuildMemberNote(self.guildId, guildMemberIndex, note) break end end end local function OnGuildMemberPromoteSuccessful(eventId, displayName, newRankIndex, guildId) if self:MatchesGuild(guildId) and newRankIndex > 0 then local rankText = GetFinalGuildRankName(guildId, newRankIndex) local rankIcon = zo_iconFormat(GetFinalGuildRankTextureSmall(guildId, newRankIndex), 32, 32) local alertText = zo_strformat(SI_GUILD_NOTIFY_PROMOTED, ZO_FormatUserFacingDisplayName(displayName), rankIcon, rankText) ZO_Alert(UI_ALERT_CATEGORY_ALERT, nil, alertText) end end local function OnGuildMemberDemoteSuccessful(eventId, displayName, newRankIndex, guildId) if self:MatchesGuild(guildId) and newRankIndex <= GetNumGuildRanks(guildId) then local rankText = GetFinalGuildRankName(guildId, newRankIndex) local rankIcon = zo_iconFormat(GetFinalGuildRankTextureSmall(guildId, newRankIndex), 32, 32) local alertText = zo_strformat(SI_GUILD_NOTIFY_DEMOTED, ZO_FormatUserFacingDisplayName(displayName), rankIcon, rankText) ZO_Alert(UI_ALERT_CATEGORY_ALERT, nil, alertText) end end local function OnPlayerGuildRankChanged(eventId, guildId, rankIndex, guildRankChangeAction) local rankText = GetFinalGuildRankName(guildId, rankIndex) local rankIcon = zo_iconFormat(GetFinalGuildRankTextureSmall(guildId, rankIndex), 32, 32) local guildName = GetGuildName(guildId) if guildRankChangeAction == GUILD_RANK_CHANGE_ACTION_PROMOTE then local alertText = zo_strformat(SI_GUILD_PLAYER_NOTIFY_PROMOTED, rankIcon, rankText, guildName) ZO_Alert(UI_ALERT_CATEGORY_ALERT, nil, alertText) elseif guildRankChangeAction == GUILD_RANK_CHANGE_ACTION_DEMOTE then local alertText = zo_strformat(SI_GUILD_PLAYER_NOTIFY_DEMOTED, rankIcon, rankText, guildName) ZO_Alert(UI_ALERT_CATEGORY_ALERT, nil, alertText) end end self:BuildMasterList() EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_DATA_LOADED, function() self:OnGuildDataLoaded() end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_RANKS_CHANGED, function(_, guildId) if self:MatchesGuild(guildId) then self:OnGuildRanksChanged() end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_RANK_CHANGED, function(_, guildId, rankIndex) if self:MatchesGuild(guildId) then self:OnGuildRanksChanged() end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_ADDED, function(_, guildId, displayName) if self:MatchesGuild(guildId) then self:OnGuildMemberAdded(guildId, displayName) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_INVITE_REMOVED, function(_, guildId) self:RefreshData() end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_SELF_JOINED_GUILD, function(_, guildId, displayName) self:OnGuildSelfJoined() end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_REMOVED, function(_, guildId, displayName, characterName) if self:MatchesGuild(guildId) then self:OnGuildMemberRemoved(guildId, characterName, displayName) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_CHARACTER_UPDATED, function(_, guildId, displayName) if self:MatchesGuild(guildId) then self:OnGuildMemberCharacterUpdated(displayName) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_CHARACTER_ZONE_CHANGED, function(_, guildId, displayName, characterName, zone) if self:MatchesGuild(guildId) then self:OnGuildMemberCharacterZoneChanged(displayName, characterName, zone) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_CHARACTER_LEVEL_CHANGED, function(_, guildId, displayName, characterName, level) if self:MatchesGuild(guildId) then self:OnGuildMemberCharacterLevelChanged(displayName, characterName, level) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_CHARACTER_CHAMPION_POINTS_CHANGED, function(_, guildId, displayName, characterName, championPoints) if self:MatchesGuild(guildId) then self:OnGuildMemberCharacterChampionPointsChanged(displayName, characterName, championPoints) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_RANK_CHANGED, function(_, guildId, displayName, rankIndex) if self:MatchesGuild(guildId) then self:OnGuildMemberRankChanged(displayName, rankIndex) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_PLAYER_RANK_CHANGED, OnPlayerGuildRankChanged) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_PLAYER_STATUS_CHANGED, function(_, guildId, displayName, oldStatus, newStatus) if self:MatchesGuild(guildId) then self:OnGuildMemberPlayerStatusChanged(displayName, oldStatus, newStatus) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_NOTE_CHANGED, function(_, guildId, displayName, note) if self:MatchesGuild(guildId) then self:OnGuildMemberNoteChanged(displayName, note) end end) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_PROMOTE_SUCCESSFUL, OnGuildMemberPromoteSuccessful) EVENT_MANAGER:RegisterForEvent(EVENT_NAMESPACE, EVENT_GUILD_MEMBER_DEMOTE_SUCCESSFUL, OnGuildMemberDemoteSuccessful) end function ZO_GuildRosterManager:MatchesGuild(guildId) return guildId == self.guildId end function ZO_GuildRosterManager:SetGuildId(guildId) self.guildId = guildId self.guildName = GetGuildName(guildId) self.guildAlliance = GetGuildAlliance(guildId) -- We must refresh everything before notifing the listeners that the guildId has changed so that the data -- being accessed by the new guildId is the data for that guild. self:RefreshAll() self:OnGuildIdChanged() end function ZO_GuildRosterManager:RefreshAll() self:RefreshData() self:RefreshRankDependentControls() end function ZO_GuildRosterManager:RefreshRankDependentControls() self:RefreshVisible() KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor) end function ZO_GuildRosterManager:ColorRow(control, data, textColor, iconColor, textColor2) ZO_SocialList_ColorRow(control, data, textColor, iconColor, textColor2) if not self.lockedForUpdates then local rank = control:GetNamedChild("RankIcon") rank:SetColor(iconColor:UnpackRGBA()) local zone = control:GetNamedChild("Zone") zone:SetColor(textColor2:UnpackRGBA()) end end function ZO_GuildRosterManager:SetupEntry(control, data, selected) ZO_SocialList_SharedSocialSetup(control, data, selected) local note = control:GetNamedChild("Note") if note then if data.note ~= "" then if DoesPlayerHaveGuildPermission(self.guildId, GUILD_PERMISSION_NOTE_READ) then note:SetHidden(false) if DoesPlayerHaveGuildPermission(self.guildId, GUILD_PERMISSION_NOTE_EDIT) then note:SetState(BSTATE_NORMAL, false) else note:SetState(BSTATE_DISABLED, true) end else note:SetHidden(true) end else note:SetHidden(true) end end local rank = control:GetNamedChild("RankIcon") local rankTextureFunction = IsInGamepadPreferredMode() and GetFinalGuildRankTextureLarge or GetFinalGuildRankTextureSmall local rankTexture = rankTextureFunction(self.guildId, data.rankIndex) if rankTexture then rank:SetHidden(false) rank:SetTexture(rankTexture) else rank:SetHidden(true) end -- invited players are treated as always offline, regardless of what they actually are -- so just hide the status icon local isInvited = data.rankId == DEFAULT_INVITED_RANK local statusIcon = control:GetNamedChild("StatusIcon") statusIcon:SetHidden(isInvited) if isInvited then -- the zone textfield is co-opted for invited players to show they are a pending member. local zone = control:GetNamedChild("Zone") zone:SetHidden(false) zone:SetText(data.formattedZone) end end function ZO_GuildRosterManager:BuildMasterList() ZO_ClearNumericallyIndexedTable(self.masterList) local guildId = self.guildId local localPlayerIndex = GetPlayerGuildMemberIndex(guildId) local numGuildMembers = GetNumGuildMembers(guildId) for guildMemberIndex = 1, numGuildMembers do local displayName, note, rankIndex, status, secsSinceLogoff = GetGuildMemberInfo(guildId, guildMemberIndex) local online = (status ~= PLAYER_STATUS_OFFLINE) local rankId = GetGuildRankId(guildId, rankIndex) local isLocalPlayer = guildMemberIndex == localPlayerIndex local hasCharacter, rawCharacterName, zone, class, alliance, level, championPoints = GetGuildMemberCharacterInfo(guildId, guildMemberIndex) local data = { index = guildMemberIndex, displayName = displayName, hasCharacter = hasCharacter, isLocalPlayer = isLocalPlayer, characterName = ZO_CachedStrFormat(SI_UNIT_NAME, rawCharacterName), gender = GetGenderFromNameDescriptor(rawCharacterName), level = level, championPoints = championPoints, class = class, formattedZone = ZO_CachedStrFormat(SI_ZONE_NAME, zone), alliance = alliance, formattedAllianceName = ZO_CachedStrFormat(SI_ALLIANCE_NAME, GetAllianceName(alliance)), note = note, rankIndex = rankIndex, rankId = rankId, type = SOCIAL_NAME_SEARCH, status = status, } ZO_SocialList_SetUpOnlineData(data, online, secsSinceLogoff) self.masterList[guildMemberIndex] = data end local numGuildInvitees = GetNumGuildInvitees(guildId) for guildInviteeIndex = 1, numGuildInvitees do local displayName, rankIndex = GetGuildInviteeInfo(guildId, guildInviteeIndex) local data = { inviteeIndex = guildInviteeIndex, displayName = displayName, hasCharacter = false, isLocalPlayer = false, characterName = "", gender = 0, level = 0, championPoints = 0, class = 0, formattedZone = GetString(SI_GUILD_INVITED_PLAYER_LOCATION), alliance = ALLIANCE_NONE, formattedAllianceName = "", note = "", rankIndex = rankIndex, rankId = DEFAULT_INVITED_RANK, type = SOCIAL_NAME_SEARCH, status = PLAYER_STATUS_OFFLINE, } local OFFLINE_PLAYER = false local SECS_SINCE_LOG_OFF = math.huge ZO_SocialList_SetUpOnlineData(data, OFFLINE_PLAYER, SECS_SINCE_LOG_OFF) table.insert(self.masterList, data) end end function ZO_GuildRosterManager:GetNoteEditedFunction() return self.noteEditedFunction end function ZO_GuildRosterManager:GetGuildId() return self.guildId end function ZO_GuildRosterManager:GetGuildName() return self.guildName end function ZO_GuildRosterManager:GetGuildAlliance() return self.guildAlliance end function ZO_GuildRosterManager:GetPlayerData() local playerIndex = GetPlayerGuildMemberIndex(self.guildId) return self.masterList[playerIndex] end function ZO_GuildRosterManager:FindDataByDisplayName(displayName) for i = 1, #self.masterList do local data = self.masterList[i] if data.displayName == displayName then return data end end end --Events --------- function ZO_GuildRosterManager:OnGuildDataLoaded() self:RefreshAll() end function ZO_GuildRosterManager:OnGuildMemberAdded(guildId, displayName) self:RefreshData() if DoesPlayerHaveGuildPermission(self.guildId, GUILD_PERMISSION_INVITE) then local data = self:FindDataByDisplayName(displayName) if data and data.rankId ~= DEFAULT_INVITED_RANK then local hasCharacter, rawCharacterName, zone, class, alliance, level, championPoints = GetGuildMemberCharacterInfo(self.guildId, data.index) local nameToShow = IsInGamepadPreferredMode() and ZO_FormatUserFacingDisplayName(displayName) or rawCharacterName ZO_Alert(UI_ALERT_CATEGORY_ALERT, SOUNDS.GUILD_ROSTER_ADDED, zo_strformat(SI_GUILD_ROSTER_ADDED, nameToShow, self.guildName)) end end end function ZO_GuildRosterManager:OnGuildSelfJoined() PlaySound(SOUNDS.GUILD_SELF_JOINED) end function ZO_GuildRosterManager:OnGuildMemberRemoved(guildId, rawCharacterName, displayName) if DoesPlayerHaveGuildPermission(self.guildId, GUILD_PERMISSION_INVITE) then if ShouldDisplayGuildMemberRemoveAlert(rawCharacterName) then local nameToShow = IsInGamepadPreferredMode() and ZO_FormatUserFacingDisplayName(displayName) or rawCharacterName ZO_Alert(UI_ALERT_CATEGORY_ALERT, SOUNDS.GUILD_ROSTER_REMOVED, zo_strformat(SI_GUILD_ROSTER_REMOVED, nameToShow, self.guildName)) else PlaySound(SOUNDS.GUILD_ROSTER_REMOVED) end end self:RefreshData() end function ZO_GuildRosterManager:OnGuildMemberCharacterUpdated(displayName) local data = self:FindDataByDisplayName(displayName) if data then local hasCharacter, rawCharacterName, zone, class, alliance, level, championPoints = GetGuildMemberCharacterInfo(self.guildId, data.index) data.hasCharacter = hasCharacter data.characterName = ZO_CachedStrFormat(SI_UNIT_NAME, rawCharacterName) data.gender = GetGenderFromNameDescriptor(rawCharacterName) data.formattedZone = ZO_CachedStrFormat(SI_ZONE_NAME, zone) data.class = class data.alliance = alliance data.formattedAllianceName = ZO_CachedStrFormat(SI_ALLIANCE_NAME, GetAllianceName(alliance)) data.level = level data.championPoints = championPoints self:RefreshFilters() end end function ZO_GuildRosterManager:OnGuildMemberCharacterZoneChanged(displayName, characterName, zone) local data = self:FindDataByDisplayName(displayName) if data then data.formattedZone = ZO_CachedStrFormat(SI_ZONE_NAME, zone) self:RefreshSort() end end function ZO_GuildRosterManager:OnGuildMemberCharacterLevelChanged(displayName, characterName, level) local data = self:FindDataByDisplayName(displayName) if data then data.level = level self:RefreshSort() end end function ZO_GuildRosterManager:OnGuildMemberCharacterChampionPointsChanged(displayName, characterName, championPoints) local data = self:FindDataByDisplayName(displayName) if data then data.championPoints = championPoints self:RefreshSort() end end function ZO_GuildRosterManager:OnGuildMemberRankChanged(displayName, rankIndex) local data = self:FindDataByDisplayName(displayName) if data then data.rankIndex = rankIndex self:RefreshSort() local playerIndex = GetPlayerGuildMemberIndex(self.guildId) local playerDisplayName = GetGuildMemberInfo(self.guildId, playerIndex) if playerDisplayName == displayName then self:RefreshRankDependentControls() end end end function ZO_GuildRosterManager:OnGuildMemberPlayerStatusChanged(displayName, oldStatus, newStatus) local data = self:FindDataByDisplayName(displayName) if data then --Because we may have refreshed the whole list in between when this event happened and when we received it, --we must use our conception of whether they were online, not whether they were online or not when the event happened. local wasOnline = data.online local isOnline = (newStatus ~= PLAYER_STATUS_OFFLINE) data.status = newStatus if wasOnline and not isOnline then ZO_SocialList_SetUpOnlineData(data, false, 0) elseif not wasOnline and isOnline then ZO_SocialList_SetUpOnlineData(data, true) local hasCharacter, rawCharacterName, zone, class, alliance, level, championPoints = GetGuildMemberCharacterInfo(self.guildId, data.index) data.characterName = ZO_CachedStrFormat(SI_UNIT_NAME, rawCharacterName) data.gender = GetGenderFromNameDescriptor(rawCharacterName) data.formattedZone = ZO_CachedStrFormat(SI_ZONE_NAME, zone) data.class = class data.alliance = alliance data.formattedAllianceName = ZO_CachedStrFormat(SI_ALLIANCE_NAME, GetAllianceName(alliance)) data.level = level data.championPoints = championPoints end self:RefreshFilters() end end function ZO_GuildRosterManager:OnGuildMemberNoteChanged(displayName, note) local data = self:FindDataByDisplayName(displayName) if data then data.note = note self:RefreshVisible() end end function ZO_GuildRosterManager:OnGuildRanksChanged() self:RefreshAll() end function ZO_GuildRosterManager:OnUpdate(control, currentTime) if currentTime - self.lastUpdateTime > OFFLINE_TIME_UPDATE then self.lastUpdateTime = currentTime self:RefreshVisible() end end function ZO_GuildRosterManager:OnGuildIdChanged() self:CallFunctionOnLists("OnGuildIdChanged") end function ZO_GuildRosterManager.ComputeSetRankEntries(guildId, playerRankIndex, targetRankIndex, isGamepad) local entries = {} local playerHasPromotePermission = DoesPlayerHaveGuildPermission(guildId, GUILD_PERMISSION_PROMOTE) local playerHasDemotePermission = DoesPlayerHaveGuildPermission(guildId, GUILD_PERMISSION_DEMOTE) local numRanks = GetNumGuildRanks(guildId) for rankIndex = 1, numRanks do local rankName = GetFinalGuildRankName(guildId, rankIndex) local rankIconIndex = GetGuildRankIconIndex(guildId, rankIndex) local enabled = rankIndex > playerRankIndex or IsGuildRankGuildMaster(guildId, playerRankIndex) if enabled then if rankIndex < targetRankIndex then enabled = playerHasPromotePermission elseif rankIndex > targetRankIndex then enabled = playerHasDemotePermission end end table.insert(entries, { rankName = rankName, rankIcon = isGamepad and GetGuildRankLargeIcon(rankIconIndex) or GetGuildRankSmallIcon(rankIconIndex), enabled = enabled, }) end return entries end function ZO_GuildRosterManager.CanPromotePlayer(guildId, myRankIndex, theirRankIndex, theirRankId) if DoesPlayerHaveGuildPermission(guildId, GUILD_PERMISSION_PROMOTE) then if theirRankId ~= DEFAULT_INVITED_RANK and theirRankIndex > 1 then local theirNewRankIndex = theirRankIndex - 1 return myRankIndex < theirNewRankIndex or IsGuildRankGuildMaster(guildId, myRankIndex) end end return false end function ZO_GuildRosterManager.CanDemotePlayer(guildId, myRankIndex, theirRankIndex, theirRankId) if DoesPlayerHaveGuildPermission(guildId, GUILD_PERMISSION_DEMOTE) then if theirRankId ~= DEFAULT_INVITED_RANK and theirRankIndex < GetNumGuildRanks(guildId) then return myRankIndex < theirRankIndex end end return false end function ZO_GuildRosterManager.CanSetPlayerRank(guildId, myRankIndex, theirRankIndex, theirRankId) return ZO_GuildRosterManager.CanPromotePlayer(guildId, myRankIndex, theirRankIndex, theirRankId) or ZO_GuildRosterManager.CanDemotePlayer(guildId, myRankIndex, theirRankIndex, theirRankId) end -- A singleton will be used by both keyboard and gamepad screens GUILD_ROSTER_MANAGER = ZO_GuildRosterManager:New()