planning "DisplayNameFix"

[zgrssd]

Garkin and farangkao found a way for addons to possibly solve the whole "DisplayName" issue temporarily.

Basically it invovles getting the proper Display Name from your first Guild (if you have any) or from your "remmber account name" setting on the Login Screen.
They have been thinking about just working that into their addons, but I think a proper seperate addon is better.
This allows users to explicitly make all the nessesary work, and gives us one place to blank out the code once it works properly again.

Requirements to use this:
Before starting with this addon on, you must restructure your saved var files according. (basically the counter to what you do here). Otherwise you end up restting your data again.
As long as you use it, you must either be in at least 1 Guild or have checked the "rememebr account name" Checkbox on the login page.

Problems to think about:
1. If you need the display name before the OnLoadeed event, you have to add this addons as optional Dependency to your addon manifest. But those cases should be rare.
2. We need to check if the current version of GetDispalyName() is working properly (not returning nil or ""). If it does, no work has to be done.
3. We need to check if the name was successfully retreived either from the Guilds or from the CVars. If not, we best just return the result of the original GetDisplayName()

Code is following soon. And I wait for full peer review on my code before I throw out something as dangerous as this.

[farangkao]

Just to clarify, i will not fix GetDisplayName with my Addon, but i will use the Idea to determine which Account Name is active (for support for Multiple Accounts until the Bug is officially fixed) without redefining GetDisplayName.

On General your Idea is good,that way it can be easily disabled/enabled.

Some idea's (Avoid User needs to Edit his Files):
- Addon's can "subscribe" to the new GetDisplayName functionality as soon they are prepared for it.
- Addon's that don't update lately and are being tested to not loose data with a change, could be added to a list by yourself.
- In theory an Addon could read the Data into Table(s) saved under [""] ,then request the new GetDisplayName Function and save it again under ["@Accountname"], with no need for Users to fiddle around with Notepad++

Possible Problems:
- User disables your Addon before a Patch brings back the GetDisplayName properly, all "fixed" SavedVars would not be read/saved correctly, hence a possible "data loss" for the End User.
Possible workaround: User needs to confirm in the Options of your Addon first, that he is aware of this ,and won't disable it ,until the addon is officially not necessairy anymore.


Advantages of this Workaround ,then waiting for the official Fix:
- If ZOS is not doing some automatic transfer of the Saved Vars, but just fixes the Function,
it will cause a Data loss, unless the User had used your Addon before to fix it
or does a manual Edit of his SavedVars once again before the Patch is messing with the files.

[zgrssd]

--step one: get a reference on the current GDN function
local oldGDN = GetDisplayName
 
--step two, prepare the two sub functions
local function gdnGuild()
    local result = nil
 
    --try to get the name from teh Guild
    if GetNumGuilds() > 0 then
          result = GetGuildMemberInfo(GetGuildId(1), GetPlayerGuildMemberIndex(GetGuildId(1)))
    end
 
    --check if what you got is at least remotely valid just in case; if not, ignore it
   if not (result ~= nil and string.len(result) >= 2 and string.sub(result, 1, 1) == "@") then
     result = nil
   end
 
   return result
end
 
local function gdnLogin()
    local result = GetCVar("AccountName")
 
    if(result ~= nil and string.len(result) > 0) then
     result = "@" .. result
   else
     result = nil
   end
 
   return result
end
 
--Step three, build your actuall function
local function newGDN()
  local result = nil
 
  --1. Try out the Guild function. If you get a hit, out with it
  result = gdnGuild()
  if(result ~= nil) then return result end
 
  --2. Try out the Login function. If you get a hit, out with it
  result = gdnLogin()
  if(result ~= nil) then return result end
 
  --3. If all failed, at least return the normal function result
  return oldGDN ()
end
 
--Step four, check if the current function is buggy. If so, replace it:
local DName = GetDisplayName()
if (DName == nil or string.len(DName) <= 1 or string.sub(result, 1, 1) ~= "@") then
  GetDisplayName = newGDN
end

[zgrssd]

I just realised that other addons migh be interested to know my addon is there. And wheter it replaced the GetDisplayName function or not (and maybe accessing my other functions). So I am going to add the following table to the global namespace:

if(DisplayNameFix01 == nil) then

DisplayNameFix01 = { 
  oldGDN = oldGDN, 
  newGDN = newGDN,
  GDNbyGuild = gdnGuild,
  GDNbyLogin = gdnLogin
  replacedGDN = --tells you if the normal GDN was overwritten; will add proper local variable to be set in the check
}
end

Edit: Added a if block to not overwrite the global variable it it exists already
Edit2:
Notes to self:
Add a check if this addon is out of date before before checking if the oldGDN is working (doing extra nothing if the API versio ncahnges).
Maybe use libStub isntead of Global variable.

[zgrssd]

That went surprisingly well. But then again it was the idea of others who know the game a lot better then me.

Just having my addon running instantly let's the addons use the proper account names for Saved Variables. I could even test it on the NA server where I have no guild to call upon.
Uploading a Beta version of this next for fellow programmers to test.

[zgrssd]

As promised, here is the alpha/0.01 version:
http://www.esoui.com/downloads/info6...ayNameFix.html

[zgrssd]

Just uploaded version 0.02
It now has a user override and I reordered the logic to go for the fastest/most reliable ways first.