Quantcast Help with simple addon - enforcing cvars - WoWInterface
Thread Tools Display Modes
01-10-18, 08:40 AM   #1
X33STORM
A Murloc Raider
Join Date: Sep 2017
Posts: 9
Exclamation Help with simple addon - enforcing cvars

So i'm looking for a little help with this personal addon i made to enforce a list of cvars, keybinds and other fixes across all characters.
I am not really a coder, so i don't know much about this other than the most basic principles.

This mod should run these cvars when i log on a character as is.
Problem is that both config-cache.wtf and AdvancedInterfaceOptions has some of these cvars, and i want this to override any other settings set by either the game or other addons.
I'm not sure if this already does that by running on every character login entering the world, either way i want to be sure this works as intended.

Now i' thinking maybe i need either to name the mod so it is loaded after? before? all other mods, like calling it !MyCvars.
Or the code needs to be executed at a point later than what the game config and AdvancedInterfaceOptions does.

Anyone maybe able to help me with this?

X33STORM.lua
Code:
local function eventHandler(self,event,...)

-- Floating Combat Text
SetCVar("enableFloatingCombatText", 1)
SetCVar("floatingCombatTextFloatMode", 1)
SetCVar("floatingCombatTextAllSpellMechanics", 0)
SetCVar("floatingCombatTextAuras", 0)
SetCVar("floatingCombatTextCombatDamageStyle", 1)
SetCVar("floatingCombatTextCombatDamage", 1)
SetCVar("floatingCombatTextCombatHealing", 1)
SetCVar("floatingCombatTextCombatDamageAllAutos", 1)
SetCVar("floatingCombatTextCombatDamageDirectionalScale", 1)
SetCVar("floatingCombatTextCombatDamageDirectionalOffset", 1)
SetCVar("floatingCombatTextCombatHealingAbsorbSelf", 1)
SetCVar("floatingCombatTextCombatHealingAbsorbTarget", 1)
SetCVar("floatingCombatTextCombatLogPeriodicSpells", 1)
SetCVar("floatingCombatTextCombatState", 1)
SetCVar("floatingCombatTextComboPoints", 1)
SetCVar("floatingCombatTextDamageReduction", 0)
SetCVar("floatingCombatTextDodgeParryMiss", 1)
SetCVar("floatingCombatTextEnergyGains", 1)
SetCVar("floatingCombatTextFriendlyHealers", 1)
SetCVar("floatingCombatTextHonorGains", 0)
SetCVar("floatingCombatTextLowManaHealth", 1)
SetCVar("floatingCombatTextPeriodicEnergyGains", 0)
SetCVar("floatingCombatTextPetMeleeDamage", 1)
SetCVar("floatingCombatTextPetSpellDamage", 1)
SetCVar("floatingCombatTextReactives", 1)
SetCVar("floatingCombatTextRepChanges", 0)
SetCVar("floatingCombatTextSpellMechanics", 1)
SetCVar("floatingCombatTextSpellMechanicsOther", 1)

-- Nameplate Settings
SetCVar("nameplateShowSelf", 0)
SetCVar("nameplateShowAll", 1)
SetCVar("nameplateShowEnemies", 1)
SetCVar("nameplateShowFriends", 1)
SetCVar("nameplateMaxDistance", 75)

-- Nameplate Fixes
SetCVar("nameplateLargeTopInset", -1)
SetCVar("nameplateOtherTopInset", -1)
SetCVar("nameplateLargeBottomInset", -1)
SetCVar("nameplateOtherBottomInset", -1)
SetCVar("nameplateHorizontalScale", 1)

-- Misc
SetCVar("useCompactPartyFrames", 1)
SetCVar("autoLootDefault", 1)
SetCVar("TargetNearestUseNew", 0)

end

local frame = CreateFrame("Frame","CVarSet")
frame:RegisterEvent("PLAYER_ENTERING_WORLD")
frame:SetScript("OnEvent",eventHandler)

Last edited by X33STORM : 01-26-18 at 10:58 AM.
  Reply With Quote
01-10-18, 09:25 AM   #2
Tim
A Cobalt Mageweaver
 
Tim's Avatar
AddOn Author - Click to view addons
Join Date: Apr 2008
Posts: 233
Alter your .toc and add an optional dependency for AIO.

Code:
# OptionalDeps: AdvancedInterfaceOptions
This will make it so that addon loads before yours. As for the config-cache.wtf, this is character specific settings that generally require a game restart to take into effect. You should be good to go once you add that to your toc.
  Reply With Quote
01-10-18, 09:48 AM   #3
X33STORM
A Murloc Raider
Join Date: Sep 2017
Posts: 9
Originally Posted by Tim View Post
Alter your .toc and add an optional dependency for AIO.

Code:
# OptionalDeps: AdvancedInterfaceOptions
This will make it so that addon loads before yours. As for the config-cache.wtf, this is character specific settings that generally require a game restart to take into effect. You should be good to go once you add that to your toc.
Well ain't that just a stroke of brilliance, thanks buddy
  Reply With Quote
01-10-18, 09:53 AM   #4
Fizzlemizz
I did that?
 
Fizzlemizz's Avatar
Premium Member
AddOn Author - Click to view addons
Join Date: Dec 2011
Posts: 891
Does it matter the order the addon loads because the function isn't being called until PLAYER_ENTERING_WORLD, unless of course addons receive events in the order they loaded which I have no idea about.

Doesn't AIO only set CVars when you action them in its UI?.

That said, this function will fire every time you see a loading screen. If you want a single event when the game loads use PLAYER_LOGIN.
__________________
Fizzlemizz
Maintainer of Discord Unit Frames and Discord Art.
Author of FauxMazzle and Move Pad Plus.
  Reply With Quote
01-10-18, 10:38 AM   #5
Kanegasi
A Cobalt Mageweaver
 
Kanegasi's Avatar
AddOn Author - Click to view addons
Join Date: Apr 2007
Posts: 229
Originally Posted by Fizzlemizz View Post
Does it matter the order the addon loads because the function isn't being called until PLAYER_ENTERING_WORLD, unless of course addons receive events in the order they loaded which I have no idea about.

Doesn't AIO only set CVars when you action them in its UI?.

That said, this function will fire every time you see a loading screen. If you want a single event when the game loads use PLAYER_LOGIN.
Frames get events in the order they were registered. If you want a frame to always go last when an event registers, you can find a way to occasionally call UnregisterEvent then RegisterEvent right after, such as in ADDON_LOADED or UNIT_AURA or something like a 5 second OnUpdate. There’s some chat update events that are spammed during loading between ADDON_LOADED and PLAYER_LOGIN you could use if you’re confident addons wouldn’t try to register afterwards.

If you want to ensure your frame goes first, you can do the same thing but with the first return of GetFramesRegisteredForEvent("event"), which returns an ordered list of frames, the first one being the first one that was registered.

“Lua” Code:
  1. local myframe=CreateFrame(‘frame’)
  2. myframe:RegisterEvent(‘event’)
  3. local firstframe=GetFramesRegisteredForEvent(‘event’)
  4. while firstframe~=myframe do
  5.     firstframe:UnregisterEvent(‘event’)
  6.     firstframe:RegisterEvent(‘event’)
  7.     firstframe=GetFramesRegisteredForEvent(‘event’)
  8. end
  Reply With Quote
01-10-18, 11:39 AM   #6
Fizzlemizz
I did that?
 
Fizzlemizz's Avatar
Premium Member
AddOn Author - Click to view addons
Join Date: Dec 2011
Posts: 891
Now I know, thank you.
__________________
Fizzlemizz
Maintainer of Discord Unit Frames and Discord Art.
Author of FauxMazzle and Move Pad Plus.
  Reply With Quote
01-11-18, 10:19 AM   #7
semlar
A Pyroguard Emberseer
 
semlar's Avatar
AddOn Author - Click to view addons
Join Date: Sep 2007
Posts: 1,041
Originally Posted by Fizzlemizz View Post
Doesn't AIO only set CVars when you action them in its UI?
AIO has an option to "enforce" all cvars that were set the last time you logged out, so temporary and character-specific cvars get reapplied the next time you log into any character.

It's meant to keep a global list of settings so if you change something it stays changed across your whole account.

Originally it was intended to prevent other addons from modifying cvars that you set manually through AIO, but I modified it to allow the changes but track which addon last touched the cvar so you can see it in the cvar browser.

Loading after AIO does might not always work. It reapplies the settings only after both VARIABLES_LOADED and ADDON_LOADED fires for it. If VARIABLES_LOADED fires after ADDON_LOADED does, setting it as an optional dependency won't be enough, and you'll have to wait for VARIABLES_LOADED to fire before overriding the settings.

Unfortunately, tracking settings that addons apply before AIO loads is considerably more complicated than the current setup, and would probably actually require loading a separate module before any other addons load, so it hasn't been done yet.

Also, this seems like a lot of personalized settings for an addon to change if this is something that's going to be distributed to other people, and the exact reason AIO tracks which addon modified which cvar, because these are things that persist after your addon is disabled and people get confused about why their settings are all different from what they had set when they turn it off and it doesn't go back to the way it was before.

Last edited by semlar : 01-11-18 at 10:35 AM.
  Reply With Quote
01-11-18, 11:16 AM   #8
Ammako
A Cobalt Mageweaver
 
Ammako's Avatar
AddOn Author - Click to view addons
Join Date: Jun 2016
Posts: 219
Originally Posted by semlar View Post
Also, this seems like a lot of personalized settings for an addon to change if this is something that's going to be distributed to other people, and the exact reason AIO tracks which addon modified which cvar, because these are things that persist after your addon is disabled and people get confused about why their settings are all different from what they had set when they turn it off and it doesn't go back to the way it was before.
OP said personal addon in the first sentence of their post.
__________________
█████████████
█████████████
█████████████
█████████████
  Reply With Quote
01-11-18, 11:17 AM   #9
semlar
A Pyroguard Emberseer
 
semlar's Avatar
AddOn Author - Click to view addons
Join Date: Sep 2007
Posts: 1,041
Originally Posted by Ammako View Post
OP said personal addon in the first sentence of their post.
If that were the case, the addon would not need to set these cvars when they could be set through AIO, making worrying about the loading process a moot point.
  Reply With Quote
01-11-18, 11:33 AM   #10
Ammako
A Cobalt Mageweaver
 
Ammako's Avatar
AddOn Author - Click to view addons
Join Date: Jun 2016
Posts: 219
Depends on whether they want to have AIO installed or not, to be fair.
__________________
█████████████
█████████████
█████████████
█████████████
  Reply With Quote
01-11-18, 11:42 AM   #11
semlar
A Pyroguard Emberseer
 
semlar's Avatar
AddOn Author - Click to view addons
Join Date: Sep 2007
Posts: 1,041
Originally Posted by Ammako View Post
Depends on whether they want to have AIO installed or not, to be fair.
If he decides to disable AIO it won't be overriding his settings any more. If he sets his cvars through AIO then it won't matter if they override his addon because they'll be the same.

It does not matter whether he has it installed or not.

Last edited by semlar : 01-11-18 at 11:46 AM.
  Reply With Quote
01-11-18, 11:50 AM   #12
Ammako
A Cobalt Mageweaver
 
Ammako's Avatar
AddOn Author - Click to view addons
Join Date: Jun 2016
Posts: 219
It sounded to me like they wanted to ensure it would override settings set by any addons. Though I guess my point is moot because OP is using AIO, but other people finding this thread from Google might not be.
__________________
█████████████
█████████████
█████████████
█████████████
  Reply With Quote
01-11-18, 01:11 PM   #13
semlar
A Pyroguard Emberseer
 
semlar's Avatar
AddOn Author - Click to view addons
Join Date: Sep 2007
Posts: 1,041
Originally Posted by Ammako View Post
It sounded to me like they wanted to ensure it would override settings set by any addons. Though I guess my point is moot because OP is using AIO, but other people finding this thread from Google might not be.
If this is the case then loading later in the loading process won't be enough to really solve this problem.

Since any addon can change any cvar at any point while the game is running, to actually prevent a cvar from being changed requires actively monitoring for any future cvar changes and reversing them (which could cause an infinite loop if someone else has the same idea that their settings are actually more important than your settings and tries to reinforce them too), and would prevent you from doing things like toggling nameplate visibility on the fly (although I believe those are combat-protected so you'd have to take that into account as well).

To anyone finding this thread later: Don't automatically change cvars in your addon unless you have a very good reason to do so, and make it clear to your users that this is something you're doing.

These settings are generally permanent, and many of them can't be set through the interface, so even if your addon is disabled its changes will remain in-place and not easily reverted.
  Reply With Quote
01-11-18, 07:54 PM   #14
Ammako
A Cobalt Mageweaver
 
Ammako's Avatar
AddOn Author - Click to view addons
Join Date: Jun 2016
Posts: 219
Originally Posted by semlar View Post
To anyone finding this thread later: Don't automatically change cvars in your addon unless you have a very good reason to do so, and make it clear to your users that this is something you're doing.

These settings are generally permanent, and many of them can't be set through the interface, so even if your addon is disabled its changes will remain in-place and not easily reverted.
Can SetCVar be called at PLAYER_LOGOUT?
If so, I imagine a (partial) solution to this could be for an addon author to revert affected CVars back to defaults at logout.
Partial, because it wouldn't work if the user incorrectly exited the game before removing the addon, without explicitly logging out properly, but for the average user, this would effectively ensure that any changes to CVars from the addon wouldn't remain after uninstalling.
__________________
█████████████
█████████████
█████████████
█████████████
  Reply With Quote
01-11-18, 08:36 PM   #15
JDoubleU00
A Rage Talon Dragon Guard
 
JDoubleU00's Avatar
AddOn Author - Click to view addons
Join Date: Mar 2008
Posts: 332
Originally Posted by Ammako View Post
Can SetCVar be called at PLAYER_LOGOUT?
If so, I imagine a (partial) solution to this could be for an addon author to revert affected CVars back to defaults at logout.
Partial, because it wouldn't work if the user incorrectly exited the game before removing the addon, without explicitly logging out properly, but for the average user, this would effectively ensure that any changes to CVars from the addon wouldn't remain after uninstalling.
I'm just thinking/typing out loud, but what if you set a flag when PLAYER_LOGOUT is properly used or exited? If the player exits improperly, then the app would know that things didn't end well and make changes appropriately.
__________________
Author of JWExpBar and JWRepBar.
  Reply With Quote
01-11-18, 08:38 PM   #16
Torhal
A Pyroguard Emberseer
 
Torhal's Avatar
AddOn Author - Click to view addons
Join Date: Aug 2008
Posts: 1,184
Originally Posted by JDoubleU00 View Post
I'm just thinking/typing out loud, but what if you set a flag when PLAYER_LOGOUT is properly used or exited? If the player exits improperly, then the app would know that things didn't end well and make changes appropriately.
Improper exit means the game crashed, which means no disk write.
__________________
Whenever someone says "pls" because it's shorter than "please", I say "no" because it's shorter than "yes".

Author of Revelation, Spamalyzer, TravelAgent, Volumizer, and many other AddOns.
  Reply With Quote
01-11-18, 08:49 PM   #17
Ammako
A Cobalt Mageweaver
 
Ammako's Avatar
AddOn Author - Click to view addons
Join Date: Jun 2016
Posts: 219
Wouldn't really help anyway, even if it worked, because the hypothetical situation is that the user removed that addon following a crash.
Remove the addon, and you'd also be removing the code which would be checking for said flag anyway. So there isn't really a point, heh, and if you aren't removing the addon it'll just resume proper functionality the next time you start the game.

btw, probably a stupid question: X-ing out of the game improperly exits the game and doesn't save saved variables, right? I can imagine a lot of less knowledgeable players doing just that in the same way that people remove usb devices without doing the whole "remove safely" thing first.
__________________
█████████████
█████████████
█████████████
█████████████

Last edited by Ammako : 01-11-18 at 08:52 PM.
  Reply With Quote
01-11-18, 08:57 PM   #18
semlar
A Pyroguard Emberseer
 
semlar's Avatar
AddOn Author - Click to view addons
Join Date: Sep 2007
Posts: 1,041
Originally Posted by Ammako View Post
btw, probably a stupid question: X-ing out of the game improperly exits the game and doesn't save saved variables, right? I can imagine a lot of less knowledgeable players doing just that in the same way that people remove usb devices without doing the whole "remove safely" thing first.
Alt-F4ing out of the game does not prevent it from writing to the disk before it exits, unless it crashes during the process.
  Reply With Quote
01-14-18, 02:19 AM   #19
aallkkaa
A Theradrim Guardian
 
aallkkaa's Avatar
AddOn Author - Click to view addons
Join Date: Jun 2017
Posts: 62
EDIT: What I say bellow is WRONG. See Ammako's reply immediately bellow for details.

Originally Posted by Torhal View Post
Improper exit means the game crashed, which means no disk write.
You can set the flag to work reversely. I.e.:
1. Check the saved flag, say "cleanExit", and do the necessary fixups if it's false or nil;
2. Set cleanExit to false upon PLAYER_LOGIN;
3. Change the CVars and whatnot;
4. Set cleanExit to true on PLAYER_LOGOUT.
The absence of write on game crash implies NO evidence of a clean exit.

Last edited by aallkkaa : 01-15-18 at 06:46 PM.
  Reply With Quote
01-14-18, 08:07 AM   #20
Ammako
A Cobalt Mageweaver
 
Ammako's Avatar
AddOn Author - Click to view addons
Join Date: Jun 2016
Posts: 219
Originally Posted by aallkkaa View Post
You can set the flag to work reversely. I.e.:
1. Check the saved flag, say "cleanExit", and do the necessary fixups if it's false or nil;
2. Set cleanExit to false upon PLAYER_LOGIN;
3. Change the CVars and whatnot;
4. Set cleanExit to true on PLAYER_LOGOUT.
The absence of write on game crash implies NO evidence of a clean exit.
Game crash = no disk write, including step 2.

You could have that variable set to true at login, change it to false at step 2. Game crashes, the change isn't saved, and it will still be set to true.

Saved Variables don't get written to until you reload/logout/exit the game, no matter how many changes you make.
__________________
█████████████
█████████████
█████████████
█████████████

Last edited by Ammako : 01-14-18 at 08:10 AM.
  Reply With Quote

WoWInterface » AddOns, Compilations, Macros » AddOn Help/Support » Help with simple addon - enforcing cvars

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off