-- Backport of the modern `PlayerLocation` / `PlayerLocationMixin` parameter -- object (Blizzard_ObjectAPI). Like `ItemLocation`, it's a lightweight -- descriptor that wraps one of several ways to identify a player — a GUID, a -- unit token, a chat line, a /who index, a battlefield-scoreboard index, etc. -- — so retail/Classic addon code can construct and inspect it unchanged. -- -- It's pure table bookkeeping: every Create/Set/Get/Is is just fields, no -- engine access. The GUID / unit / chatLine / whoIndex / battlefieldScore -- kinds all map to things vanilla 1.12 genuinely has. The community, voice, -- and Battle.net kinds have no vanilla producer, but they're kept as harmless -- data holders so the mixin matches retail exactly for any code that builds -- or reads them. Only the two methods that reach into systems 1.12 lacks — -- `IsValid` (Club) and `IsBattleNetGUID` (account info) — are guarded so they -- degrade gracefully instead of erroring on the missing `C_Club` / -- `C_AccountInfo` namespaces. local CreateFromMixins = CreateFromMixins PlayerLocation = PlayerLocation or {} PlayerLocationMixin = PlayerLocationMixin or {} --[[static]] function PlayerLocation:CreateFromGUID(guid) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetGUID(guid) return playerLocation end --[[static]] function PlayerLocation:CreateFromUnit(unit) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetUnit(unit) return playerLocation end --[[static]] function PlayerLocation:CreateFromChatLineID(lineID) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetChatLineID(lineID) return playerLocation end --[[static]] function PlayerLocation:CreateFromBattlefieldScoreIndex(battlefieldScoreIndex) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetBattlefieldScoreIndex(battlefieldScoreIndex) return playerLocation end --[[static]] function PlayerLocation:CreateFromWhoIndex(whoIndex) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetWhoIndex(whoIndex) return playerLocation end --[[static]] function PlayerLocation:CreateFromVoiceID(memberID, channelID) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetVoiceID(memberID, channelID) return playerLocation end --[[static]] function PlayerLocation:CreateFromBattleNetID(battleNetID) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetBattleNetID(battleNetID) return playerLocation end --[[static]] function PlayerLocation:CreateFromCommunityChatData(clubID, streamID, epoch, position) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetCommunityData(clubID, streamID, epoch, position) return playerLocation end --[[static]] function PlayerLocation:CreateFromCommunityInvitation(clubID, guid) local playerLocation = CreateFromMixins(PlayerLocationMixin) playerLocation:SetCommunityInvitation(clubID, guid) return playerLocation end --[[public api]] function PlayerLocationMixin:SetGUID(guid) self:ClearAndSetField("guid", guid) end function PlayerLocationMixin:IsValid() if self:IsCommunityData() then -- Vanilla has no Community/Club system; if the namespace is -- absent a community location can never be resolved. if C_Club and C_Club.CanResolvePlayerLocationFromClubMessageData then return C_Club.CanResolvePlayerLocationFromClubMessageData(self.communityClubID, self.communityStreamID, self.communityEpoch, self.communityPosition) end return false end return true end function PlayerLocationMixin:IsGUID() return self.guid ~= nil end function PlayerLocationMixin:IsBattleNetGUID() -- No Battle.net accounts on 1.12; guarded so it returns false instead -- of erroring on a missing C_AccountInfo. if self.guid and C_AccountInfo and C_AccountInfo.IsGUIDBattleNetAccountType then return C_AccountInfo.IsGUIDBattleNetAccountType(self.guid) end return false end function PlayerLocationMixin:GetGUID() return self.guid or self.communityClubInviterGUID end function PlayerLocationMixin:SetUnit(unit) self:ClearAndSetField("unit", unit) end function PlayerLocationMixin:IsUnit() return self.unit ~= nil end function PlayerLocationMixin:GetUnit() return self.unit end function PlayerLocationMixin:SetChatLineID(lineID) self:ClearAndSetField("chatLineID", lineID) end function PlayerLocationMixin:IsChatLineID() return self.chatLineID ~= nil end function PlayerLocationMixin:GetChatLineID() return self.chatLineID end function PlayerLocationMixin:SetBattlefieldScoreIndex(index) self:ClearAndSetField("battlefieldScoreIndex", index) end function PlayerLocationMixin:IsBattlefieldScoreIndex() return self.battlefieldScoreIndex ~= nil end function PlayerLocationMixin:GetBattlefieldScoreIndex() return self.battlefieldScoreIndex end function PlayerLocationMixin:SetWhoIndex(whoIndex) self:ClearAndSetField("whoIndex", whoIndex) end function PlayerLocationMixin:IsWhoIndex() return self.whoIndex ~= nil end function PlayerLocationMixin:GetWhoIndex() return self.whoIndex end function PlayerLocationMixin:SetVoiceID(memberID, channelID) self:Clear() self.voiceMemberID = memberID self.voiceChannelID = channelID end function PlayerLocationMixin:IsVoiceID() return self.voiceMemberID ~= nil and self.voiceChannelID ~= nil end function PlayerLocationMixin:GetVoiceID() return self.voiceMemberID, self.voiceChannelID end function PlayerLocationMixin:SetBattleNetID(battleNetID) self:Clear() self.battleNetID = battleNetID end function PlayerLocationMixin:IsBattleNetID() return self.battleNetID ~= nil end function PlayerLocationMixin:GetBattleNetID() return self.battleNetID end function PlayerLocationMixin:SetCommunityData(clubID, streamID, epoch, position) self:Clear() self.communityClubID = clubID self.communityStreamID = streamID self.communityEpoch = epoch self.communityPosition = position end function PlayerLocationMixin:IsCommunityData() return self.communityClubID ~= nil and self.communityStreamID ~= nil and self.communityEpoch ~= nil and self.communityPosition ~= nil end function PlayerLocationMixin:SetCommunityInvitation(clubID, guid) self:Clear() self.communityClubID = clubID self.communityClubInviterGUID = guid end function PlayerLocationMixin:IsCommunityInvitation() return self.communityClubID ~= nil and self.communityClubInviterGUID ~= nil end --[[private api]] function PlayerLocationMixin:Clear() self.guid = nil self.unit = nil self.chatLineID = nil self.battlefieldScoreIndex = nil self.whoIndex = nil self.voiceMemberID = nil self.voiceChannelID = nil self.communityClubID = nil self.communityStreamID = nil self.communityEpoch = nil self.communityPosition = nil self.communityClubInviterGUID = nil self.battleNetID = nil end function PlayerLocationMixin:ClearAndSetField(fieldName, field) self:Clear() self[fieldName] = field end