How to load WoW addon after CLUB_STREAM_SUBSCRIBED event? - lua

Question

Disclaimer I dont know how to code at all and this is my first atempt at rewriting someone elses addon.
I need to check for the following before the addon loads at all.
frame:RegisterEvent("CLUB_STREAM_SUBSCRIBED");
The issue is, I dont know where or how to do that. I tried adding it on line 19 and then changing line 6 to if event == 'ADDON_LOADED' and arg1 == 'unitscan' and event == 'CLUB_STREAM_SUBSCRIBED' then
The entire code can be found at https://github.com/Damnedprinter/unitscan/blob/master/unitscan.lua

Answer 1

Bottom line up front:
You have, at a minimum, a mistake in Boolean logic where you say
event == 'this' and event == 'that'
but obviously something cannot be both at the same time. You can remedy this using two methods:
if ... elseif ... end (recommended for most situations)
event == 'this' or event == 'that' (not recommended)
Detailed Answer:
1. How the original addon works:
Your code on GitHub is comparable to the following:
local frame = CreateFrame("Frame");
frame:SetScript("OnEvent", function(__, event, arg1)
if (event == "ADDON_LOADED" and arg1 == "unitscan") then
doStuff();
end
end);
frame:RegisterEvent("ADDON_LOADED");
This creates a frame and tells it to respond whenever any addon finishes loading. It responds with an event handler that receives the type of the event (as event) and an argument (as arg1) which can mean different things for different kinds of events. In this example, arg1 will be the name of the addon that just finished loading (see ADDON_LOADED on Wowpedia).
The original author didn't want to do something when just any addon is loaded, so it checks to see that arg1 equals "unitscan" during the ADDON_LOADED event.
RegisterEvent is what causes the handler to be active. I can see in your source code on Git that there are in fact three different events which share the same handler... so that's why it always checks if event == 'NAME_OF_EVENT' to disambiguate which one is happening.
2. Making it work for you:
If you want the addon to also respond to CLUB_STREAM_SUBSCRIBED then I recommend using another elseif statement like in this example:
frame:SetScript("OnEvent", function(__, event, arg1, arg2)
if (event == "ADDON_LOADED" and arg1 == "unitscan") then
doStuff();
elseif (event == "CLUB_STREAM_SUBSCRIBED") then
doOtherStuff();
end
end);
Note I changed the handler to receive two arguments that I arbitrarily called arg1 and arg2. According to documentation on Wowpedia, these will be the club and stream IDs respectively. I don't know if you need these ID values for your purposes, but offer it just in case.
3. An alternative solution:
I don't recommend this solution for you! This is just an alternative.
If you want to execute the exact same code for both events, then you could simplify the above by using an or operator and some parenthesis to control the order of operations.
frame:SetScript("OnEvent", function(__, event, arg1, arg2)
if (
(event == "ADDON_LOADED" and arg1 == "unitscan")
or (event == "CLUB_STREAM_SUBSCRIBED")
) then
doStuff();
end
end);
4. Yet another solution, responding to the comment below rather than the original question
If the goal is to delay execution, then you might consider changing from ADDON_LOADED to another event such as PLAYER_ENTERING_WORLD. However, this also fires when you are entering an instance or travelling on the boat to another continent. As such, the sample code below deregisters the event to prevent this frame from acting on it more than once.
frame:SetScript("OnEvent", function(__, event, ...)
if (event == "PLAYER_ENTERING_WORLD") then
frame:UnregisterEvent("PLAYER_ENTERING_WORLD");
doStuff();
end
end);
frame:RegisterEvent("PLAYER_ENTERING_WORLD");