[Lua] Gossip Dropdown Menus

[Dynashock]

Gossip Dropdown Menus
What will we be learning to create?
In this guide I will explain how one can create a gossip script which contains dropdown menus. What are dropdown menus, I hear you ask? They're not commonly used, because not many people know they exist nor do they know how to create one. However, they can greatly enhance your gossip script, if properly used. This is what we will end up with:



Okay, alright, let's start! Ho-ho, hold on, young padawan! I will not be explaining the basics of a gossip script in this guide as I will be only explaining the new bits. If you want to learn how to script a gossip I point you in the direction of the guides section.

I will explain it with this script, however keep in mind that I will be only explaining the dropdown and therefore the rest of the menu items and the script isn't included. Thus if you see a [...] something's been taken away to make it easier to understand.

function Test_Unit_Gossip(pUnit, event, player, pMisc, intid)
	pUnit:GossipCreateMenu(50, player, 0)
	pUnit:GossipMenuAddItem(0, "|cff3060B5Current status:|r Looking for Racers!", 1, 0)
	pUnit:GossipMenuAddItem(9, "Sign me up for this race!", 2, 0)
	[...] -- skipping out this bit as we don't need it for this guide
	pUnit:GossipMenuAddItem(0, "   > Racer 3", 3, 0)
	if (intid == 3) then
		pUnit:GossipMenuAddItem(0, "|cff095F0B     > Races won: 0", 0)
		pUnit:GossipMenuAddItem(0, "|cFFFF0000     > Races lost: 0", 0)
	end
	pUnit:GossipMenuAddItem(7, "[Exit]", 50, 0)
	pUnit:GossipSendMenu(player)
end

function Test_Unit_Select(pUnit, event, player, id, intid, code, pMisc)
	if (intid == 50) then
		player:GossipComplete()
	end
	
	if (intid == 3) then
		Test_Unit_Gossip(pUnit, player, intid)
	end
end

RegisterUnitGossipEvent(50, 1, "Test_Unit_Gossip")
RegisterUnitGossipEvent(50, 2, "Test_Unit_Select")

Alright, there's the script we'll be using! Now for the real work.

function Test_Unit_Gossip(pUnit, event, player, pMisc, intid)

You should've noticed something immediately in the parameters of this function. Yes, that's right! We have included an 'intid' parameter in the gossip function which normally isn't there. We'll be needing this parameter later on.

pUnit:GossipMenuAddItem(0, "   > Racer 3", 3, 0)
[...]
function Test_Unit_Select(pUnit, event, player, id, intid, code, pMisc)
	if (intid == 3) then
		Test_Unit_Gossip(pUnit, player, intid)
	end
end

So we press the " > Racer 3" item with intid 3. The Test_Unit_Select function is ran and we have a match. What happens then? Lua calls the Test_Unit_Gossip function again, huh? Does that mean we get back to the menu selection screen then? Yep, that's correct. The script sends us back to the gossip menu, but with some extra information this time. Namely, it's sending the intid to the gossip menu , too! Remember the parameter 'intid' in our gossip menu? It's ready for use, sir!

Notice how it also sends the pUnit and player. If we wouldn't be including these we would get an error in the script, as the Test_Unit_Gossip function requires those variables to run, which normally are generated on the fly due to the RegisterEvent.

function Test_Unit_Gossip(pUnit, event, player, pMisc, intid)
[...]
	if (intid == 3) then
		pUnit:GossipMenuAddItem(0, "|cff095F0B     > Races won: 0", 0)
		pUnit:GossipMenuAddItem(0, "|cFFFF0000     > Races lost: 0", 0)
	end

If we're sent back from the selection with the intid it means we can check what value the intid contains. Considering we were sent back with intid as 3, we would have a match here. In case we have a match two additional menu items are displayed, these will appear under the racer! If it's done doing this it'll continue with the rest of the script thus we end up with the menu as displayed in the picture. I have added the spaces (not tabs) in the menu item name so it really looks like it's part of the item above it.

And that basically wraps it up! Thank you for reading and may it help you in your future gossips.


If any question arise, please do not hesitate to ask me or send me a PM.


PS. I'm not writing any race script at the moment so don't ask for the "full" script, this script was created for the purpose of this guide.

[slade1000]

Thats nice work I did not know you could do this thanks

[stoneharry]

Solid guide, explains it well and actually goes beyond basic Lua unlike the other guides I have seen. It is also actually useful. Hope to see more from you.

[Link_S]

Finally you unreveal your Lua skills, :P
I hope to see a lot more of this my friend

By the way is it really necessary to check the intid in the selection also, cause I don't think it is if you call the function wheter the intid is that or that?

[Dynashock]

Finally you unreveal your Lua skills, :P
I hope to see a lot more of this my friend

By the way is it really necessary to check the intid in the selection also, cause I don't think it is if you call the function wheter the intid is that or that?

Given the current script it's not neccesary no, considering we always want to return to the gossip menu, but with multiple menu items you don't always want every menu item to send you back to the gossip menu.

[Reflection]

Amazing work Dynashock, keep it up!

[Confucius]

Great guide +Rep 3 if I can from me

[thebigman]

So technically we did not even need that, you could just have another page/option. This is for vanity ><

[Dynashock]

So technically we did not even need that, you could just have another page/option. This is for vanity ><

Of course, it's just eye candy and easier accessibility. Another page would do the same, but by showing a different kind of approach it might open one's eye. You could say you could use it as a source of inspiration and it's fun to try some new things once in a while.

Performance wise dependant on exactly what you are trying to do you might be better off with a new page though.

[XatoA]

Thats great, im just learning lua but will use this +1 rep

edit- says i cant give reputation here?