WoW:Parsing event messages - Revision history

Move page script: Move page script moved page Parsing event messages to WoW:Parsing event messages without leaving a redirect

2023-08-15T04:48:53Z

Move page script moved page Parsing event messages to Parsing event messages without leaving a redirect

← Older revision

Revision as of 04:48, 15 August 2023

Bear at 09:19, 21 May 2020

2020-05-21T09:19:55Z

← Older revision		Revision as of 09:19, 21 May 2020
Line 1:		Line 1:
	{{~~Ood\|~~}}		{{wow/uihowto}}
	~~{{wikify}}~~

	Event messages are things like combat log messages, loot messages, online/offline notifications, and so on.		Event messages are things like combat log messages, loot messages, online/offline notifications, and so on.

Line 10:		Line 8:
	In order to get this information, you need to parse the big long string.		In order to get this information, you need to parse the big long string.

	== What's the quick-and-dirty way to parse an event message? ==		== Parsing messages the quick way ==
			What's the quick-and-dirty way to parse an event message?

	Well, you can look at how the event message looks, and you can manually write a string.find over that string to extract the information you need. For example,		Well, you can look at how the event message looks, and you can manually write a string.find over that string to extract the information you need. For example,
Line 49:		Line 48:
	end		end

	== What's the clean-and-easy way? ==		== Parsing messages the clean way ==
			What's the clean-and-easy way?

	Well, first, you should extract GlobalStrings.lua out of your WoW install. Then, you will want to look through that file for the variable that contains the template of the message you're looking for. In our case, it is		Well, first, you should extract GlobalStrings.lua out of your WoW install. Then, you will want to look through that file for the variable that contains the template of the message you're looking for. In our case, it is
Line 81:		Line 81:
	MarsMessageParser will take care of reading the GlobalStrings.lua, creating the correct pattern for the current locale, re-ordering the parameters accordingly, and finally calling MyHonorTrackingFunction with three parameters: killed, rank, and honor.		MarsMessageParser will take care of reading the GlobalStrings.lua, creating the correct pattern for the current locale, re-ordering the parameters accordingly, and finally calling MyHonorTrackingFunction with three parameters: killed, rank, and honor.

	== What's the Clean-And-Not-So-Easy way? ==		== Parsing messages the right way ==
			What's the Clean-And-Not-So-Easy way?

	If you don't want to download the MarsMessageParser and include it in your addon, the thing you're left to do is find a way to do it yourself. But rather than develop a ton of code, you just want to "hardwire" your addon for just the string you want to use, rather than the infinite amount of infinite variables in every string in GlobalStrings.lua.		If you don't want to download the MarsMessageParser and include it in your addon, the thing you're left to do is find a way to do it yourself. But rather than develop a ton of code, you just want to "hardwire" your addon for just the string you want to use, rather than the infinite amount of infinite variables in every string in GlobalStrings.lua.

WoWWiki>Mowngle at 16:59, 20 September 2008

2008-09-20T16:59:41Z

← Older revision		Revision as of 16:59, 20 September 2008
Line 86:		Line 86:
	Well, let's look at FACTION_STANDING_INCREASED. According to GlobalStrings.lua, this says "Reputation with %s increased by %d." Well, to make it work like the strings at the top, we'd need to replace %s and %d with (.+). But how do we do that? Here's how:		Well, let's look at FACTION_STANDING_INCREASED. According to GlobalStrings.lua, this says "Reputation with %s increased by %d." Well, to make it work like the strings at the top, we'd need to replace %s and %d with (.+). But how do we do that? Here's how:

	newpattern = string.gsub(string.gsub(~~FACTION_STANDING_DECREASED~~, "(%%s)", "(.+)"), "(%%d)", "(.+)")		newpattern = string.gsub(string.gsub(FACTION_STANDING_INCREASED, "(%%s)", "(.+)"), "(%%d)", "(.+)")
	start, end, faction, amount = string.find(string, newpattern)		start, end, faction, amount = string.find(string, newpattern)

	This example will properly parse the string, and return all the information we need. How was this achieved? By using a % in front of the %s, it tells it to look for %s in stead of a space, which is what %s would normally be looking for. This way, even though we have to hardcode in the strings we want, we can also don't have to bother with translations.		This example will properly parse the string, and return all the information we need. How was this achieved? By using a % in front of the %s, it tells it to look for %s in stead of a space, which is what %s would normally be looking for. This way, even though we have to hardcode in the strings we want, we can also don't have to bother with translations.
	[[Category:HOWTOs\|Parse Event Messages]]		[[Category:HOWTOs\|Parse Event Messages]]

WoWWiki>Charibot: catfix, Replaced:
{{ood → {{Ood

2008-07-08T02:36:52Z

catfix, Replaced: <br>{{ood → {{Ood

← Older revision		Revision as of 02:36, 8 July 2008
Line 1:		Line 1:
	{{~~ood~~}}		{{Ood\|}}
	{{wikify}}		{{wikify}}

WoWWiki>Sylvanaar at 15:23, 9 April 2008

2008-04-09T15:23:19Z

← Older revision		Revision as of 15:23, 9 April 2008
Line 1:		Line 1:
			{{ood}}
	{{wikify}}		{{wikify}}

WoWWiki>Shearer: /* What's so dirty about the quick-and-dirty way? */

2008-01-14T14:31:27Z

What's so dirty about the quick-and-dirty way?

← Older revision		Revision as of 14:31, 14 January 2008
Line 22:		Line 22:
	end		end

	~~== What's so dirty about the quick-and-dirty way? ==~~

	You will find that as people in other locales start using your AddOn, that they have problems. This is due to the fact that your code is expecting the system messages to be arriving in English, whereas they might actually be arriving in some other language.

	Once you've started off on the quick-and-dirty way, you are likely to consider asking people to provide you translations, so you can modify your code accordingly for a quick-and-dirty fix. However, you can tell what a mess your code would quickly turn into:
	function MyHonorTracker_OnEvent()		function MyHonorTracker_OnEvent()
	if(event == "CHAT_MSG_COMBAT_HONOR_GAIN") then		if(event == "CHAT_MSG_COMBAT_HONOR_GAIN") then
Line 35:		Line 30:
	elseif(GetLocale() == "frFR") then		elseif(GetLocale() == "frFR") then
	pattern = "french-words (.+) french-words (.+) french-words (.+)";		pattern = "french-words (.+) french-words (.+) french-words (.+)";
	-- ~~notice that the parameters are not necessarily always in the same order in all languages~~		elseif(GetLocale() == "koKR") then
			pattern = "(.+) korean-for-dies, korean-words: (.+) %(more-korean: (.+)%)";
	else		else
	pattern = "who knows";		pattern = "who knows";

WoWWiki>Pcj: Wikify

2008-01-07T23:39:55Z

Wikify

← Older revision		Revision as of 23:39, 7 January 2008
Line 1:		Line 1:
	~~== What are event messages? ==~~		{{wikify}}

	Event messages are things like combat log messages, loot messages, online/offline notifications, and so on.		Event messages are things like combat log messages, loot messages, online/offline notifications, and so on.

	~~== Why would I want to parse event messages? ==~~

	If you are writing an AddOn that wants to take some sort of action when a certain event happens (for example, tracking your honor from PvP kills), you need to find the correct event and register to listen for that event. Some events provide you the information about that event in compact easy-to-use arguments. For example, the REPLACE_ENCHANT event has two arguments, arg1 (the name of the enchant) and arg2 (the name of the item). Other events don't provide you the arguments in such an easy-to-use form. For example, the CHAT_MSG_COMBAT_HONOR_GAIN event has one big long argument, arg1, that looks something like "Joe dies, honorable kill Rank: Commander (Estimated Honor Points: 10)". What you really want to know, though, is		If you are writing an AddOn that wants to take some sort of action when a certain event happens (for example, tracking your honor from PvP kills), you need to find the correct event and register to listen for that event. Some events provide you the information about that event in compact easy-to-use arguments. For example, the REPLACE_ENCHANT event has two arguments, arg1 (the name of the enchant) and arg2 (the name of the item). Other events don't provide you the arguments in such an easy-to-use form. For example, the CHAT_MSG_COMBAT_HONOR_GAIN event has one big long argument, arg1, that looks something like "Joe dies, honorable kill Rank: Commander (Estimated Honor Points: 10)". What you really want to know, though, is

WoWWiki>Kjasi: The Clean-And-Not-So-Easy way

2007-10-27T06:44:33Z

The Clean-And-Not-So-Easy way

← Older revision		Revision as of 06:44, 27 October 2007
Line 85:		Line 85:

	MarsMessageParser will take care of reading the GlobalStrings.lua, creating the correct pattern for the current locale, re-ordering the parameters accordingly, and finally calling MyHonorTrackingFunction with three parameters: killed, rank, and honor.		MarsMessageParser will take care of reading the GlobalStrings.lua, creating the correct pattern for the current locale, re-ordering the parameters accordingly, and finally calling MyHonorTrackingFunction with three parameters: killed, rank, and honor.

			== What's the Clean-And-Not-So-Easy way? ==
			If you don't want to download the MarsMessageParser and include it in your addon, the thing you're left to do is find a way to do it yourself. But rather than develop a ton of code, you just want to "hardwire" your addon for just the string you want to use, rather than the infinite amount of infinite variables in every string in GlobalStrings.lua.

			Well, let's look at FACTION_STANDING_INCREASED. According to GlobalStrings.lua, this says "Reputation with %s increased by %d." Well, to make it work like the strings at the top, we'd need to replace %s and %d with (.+). But how do we do that? Here's how:

			newpattern = string.gsub(string.gsub(FACTION_STANDING_DECREASED, "(%%s)", "(.+)"), "(%%d)", "(.+)")
			start, end, faction, amount = string.find(string, newpattern)

			This example will properly parse the string, and return all the information we need. How was this achieved? By using a % in front of the %s, it tells it to look for %s in stead of a space, which is what %s would normally be looking for. This way, even though we have to hardcode in the strings we want, we can also don't have to bother with translations.
	[[Category:HOWTOs\|Parse Event Messages]]		[[Category:HOWTOs\|Parse Event Messages]]

WoWWiki>VoidvectorBot: Bot: Fixing wiki syntax

2007-01-27T05:13:44Z

Bot: Fixing wiki syntax

← Older revision		Revision as of 05:13, 27 January 2007
Line 62:		Line 62:
	Harnessing this information yourself can be quite a task. You need to revise your code to look at this variable, transform the value of this variable into a value suitable for your pattern variable, run your pattern, and then be able to reorder the parameters correctly based on the value of this variable.		Harnessing this information yourself can be quite a task. You need to revise your code to look at this variable, transform the value of this variable into a value suitable for your pattern variable, run your pattern, and then be able to reorder the parameters correctly based on the value of this variable.

	However, each AddOn author should not have to do nearly this much work. There's a library called MarsMessageParser. I don't have a link to that file directly, but you will find it as a separate file inside of [[http://ui.worldofwar.net/ui.php?id=291 this AddOn]]. You can copy MarsMessageParser.lua out of MarsNeedyGreedy and put it in your AddOn, say MyHonorTracker. Make sure MarsMessageParser.lua is listed before MyHonorTracker.lua in your MyHonorTracker.toc file or your MyHonorTracker.xml file. Then, all of the above code can be trimmed down to just this:		However, each AddOn author should not have to do nearly this much work. There's a library called MarsMessageParser. I don't have a link to that file directly, but you will find it as a separate file inside of [http://ui.worldofwar.net/ui.php?id=291 this AddOn]. You can copy MarsMessageParser.lua out of MarsNeedyGreedy and put it in your AddOn, say MyHonorTracker. Make sure MarsMessageParser.lua is listed before MyHonorTracker.lua in your MyHonorTracker.toc file or your MyHonorTracker.xml file. Then, all of the above code can be trimmed down to just this:

	function MyHonorTracker_OnEvent()		function MyHonorTracker_OnEvent()

WoWWiki>Bsmorgan: /* What's the clean-and-easy way? */

2006-12-21T02:43:35Z

What's the clean-and-easy way?

← Older revision		Revision as of 02:43, 21 December 2006
Line 62:		Line 62:
	Harnessing this information yourself can be quite a task. You need to revise your code to look at this variable, transform the value of this variable into a value suitable for your pattern variable, run your pattern, and then be able to reorder the parameters correctly based on the value of this variable.		Harnessing this information yourself can be quite a task. You need to revise your code to look at this variable, transform the value of this variable into a value suitable for your pattern variable, run your pattern, and then be able to reorder the parameters correctly based on the value of this variable.

	However, each AddOn author should not have to do nearly this much work. There's a library called MarsMessageParser. I don't have a link to that file directly, but you will find it as a separate file inside of [[http://~~www~~.~~curse-gaming~~.~~com~~/~~mod~~.php?~~addid~~=~~2275~~ this AddOn]]. You can copy MarsMessageParser.lua out of ~~there~~ and put it in your AddOn, say MyHonorTracker. Make sure MarsMessageParser.lua is listed before MyHonorTracker.lua in your MyHonorTracker.toc file or your MyHonorTracker.xml file. Then, all of the above code can be trimmed down to just this:		However, each AddOn author should not have to do nearly this much work. There's a library called MarsMessageParser. I don't have a link to that file directly, but you will find it as a separate file inside of [[http://ui.worldofwar.net/ui.php?id=291 this AddOn]]. You can copy MarsMessageParser.lua out of MarsNeedyGreedy and put it in your AddOn, say MyHonorTracker. Make sure MarsMessageParser.lua is listed before MyHonorTracker.lua in your MyHonorTracker.toc file or your MyHonorTracker.xml file. Then, all of the above code can be trimmed down to just this:

	function MyHonorTracker_OnEvent()		function MyHonorTracker_OnEvent()