Rock5's QuestLog Class

[rock5]

This userfunction adds a "questlog" class to the bot that provides information and some functions for the quest log (the quests you currently have). It gets this information from memory so is very fast. It also replaces the "getQuestStatus" function with one that works from memory so takes about 7% the time the old function took.

Functions And Info Available
Here are some of the new functions available;

Code: Select all

questlog:questCount()

Returns the number of quests in your quest log.

Code: Select all

questlog:haveQuest(nameorid, questgroup)

Just returns true or false if you have the quest. questgroup is optional and can be "normal", "daily" or "public".

Code: Select all

quest = questlog:getQuest(nameorid, questgroup)

Returns information about the quest. Some of the information looks like this, assuming you did the above command first. For the rest, please check the file.

Code: Select all

quest.Name 
quest.Id 
quest.Level
quest.AcceptLevel
-- There can be more than 1 quest giver
quest.QuestGiver[1].Name 
quest.QuestGiver[1].Id
-- There is only 1 quest taker
quest.QuestTaker.Name
quest.QuestTaker.Id
-- Item goals are things you have to collect or tasks you have to do.
quest.ItemGoals[1].Name
quest.ItemGoals[1].Id
quest.ItemGoals[1].NumReq
-- Kill goals are things you have to kill.
quest.KillGoals[1].Name
quest.KillGoals[1].Id
quest.KillGoals[1].NumReq
-- You can have multiple item and kill goals.

You also have the quest function.

Code: Select all

quest:isComplete()

Returns true or false if the quest is complete.

Code: Select all

quest:getKillCount(goal)

Returns the kill count of the goal specified. If 'goal' is not specified then it defaults to '1'.

Note: When getting the status of a quest that is not an item quest or kill quest (which is a minority, most quests are item or kill quests) it will fall back to using the in game function as the status can't be gotten from memory.

New: All the collected base item info is now in a separate function so that you can get info about quests you don't have.

Code: Select all

questdata = getQuestBaseData(questid)

Future Of This Userfunction
I've just added basic functions. I'll add functions as users request them, so please ask.

I can see the future of this userfunction going 2 ways. Either there is enough interest in it that the whole thing will get added to the bot, or there is not much interrest in which case I'll just add the speed improvements to getQuestStatus.

userfunction_QuestLogClass.lua

Version 0.06 - Added questgroup support to getQuestStatus to match change to bot version.

(8.59 KiB) Downloaded 368 times

userfunction_QuestLogClass.lua

Version 0.05 - Updated to support patch 5.0.5. Only works with bot rev 743 and above.

(8.17 KiB) Downloaded 357 times

For older versions of rombot revision 742 and older.

userfunction_QuestLogClass.lua

Version 0.04 - Fixed: no longer interfers with 'character' option when starting the bot.

(8.73 KiB) Downloaded 297 times

[lisa]

for nameorid can it be partial name or does it need to be the full name?

[rock5]

Partial is ok. Like the old getQuestStatus it can also handle pattern or non pattern names.

Edit: and case doesn't matter either.

[Alkaiser]

Woah! I've been waiting for something like this for ages. Excellent! Can this differentiate between quests with the same name? i.e. Extinguish More Flames daily and event quest if quest id is provided instead of quest name?

[rock5]

Woah! I've been waiting for something like this for ages. Excellent! Can this differentiate between quests with the same name? i.e. Extinguish More Flames daily and event quest if quest id is provided instead of quest name?

As I mentioned in the first post, if the quest is neither an item quest or kill quest then it falls back on using the in game function. The in game function only accepts names, not ids. By the looks of it thos quests look like they are task based quests so it will probably use the in game function so you will still have the same problem. The in game function should be updated to include id checks. I believe the QuestByName functions suffer from the same problem.

I think the issue is it's hard to get id's in the game but I'll see what I can do.

[rock5]

I think I can add support for quest ids in getQuestStatus but I'm having trouble with the QuestByName functions. I can't get their ids. I can get whether they are a daily or not so maybe I can add an option to select only dailies. I need to know if public events are seen as dailies but seeing as I don't have any public event available to me, I can't check. Could you check for me?
Use the following command in the game.

Code: Select all

/script _QuestName, _Daily, _QuestGroup = GetQuestNameByIndex( 1,1 ) SendSystemChat(_QuestName..", ".. tostring(_Daily)..", ".. _QuestGroup)

To use it, make sure you have neither of the 2 quests. If you do, abondon them. Open a dialog with the npc. Enter the command above but match the second number to the quest. The above command checks the first unaccepted quest. If you use a 2, it will check the second.

Use the above command on the daily and non daily quest and show me what it prints.

[rock5]

Never mind, some public events appeared and I was able to test it. It does see public events as dailies but I can use the 3rd returned value of the command "quest group" to tell which is which.

This is how I think I'll have the option work.

Code: Select all

AcceptQuestByName(questname, questgroup)
CompleteQuestByName(questname, questreward, questgroup)
AcceptAllQuests(questgroup)
CompleteAllQuests(questgroup)

If questgroup is specified then it has to match. Options for questgroup are "normal", "daily" and "public".

So for example if you have an npc that has normal and daily quests and you want to accept all normal quests only you can use

Code: Select all

AcceptAllQuests("normal")

Or if you have an npc that has a daily and public event with the same name and you want to accept the daily you can use

Code: Select all

AcceptQuestByName("Extinguish More Flames","daily")

How does that sound?

[Alkaiser]

Code: Select all

AcceptQuestByName("Extinguish More Flames","daily")

That works for me! Right now I'm using the DailyNotes addon to get the right quest, daily/event.

[lisa]

I'm having trouble with the QuestByName functions. I can't get their ids

I use a different in game function

Code: Select all

	i = 0
	repeat
		i = i + 1
		local index, catalogID, name, track, level, daily, bDaily_num, iQuestType, 
		questID, completed, QuestGroup = RoMScript("GetQuestInfo("..i..")")
--fancy stuff here
	until name == nil

Sounds like you have it doing what you want anyway =)

[rock5]

I use a different in game function

Like I said, I figured out how to get the Ids for the getQuestStatus function. I'm just using "GetQuestId".

What I can't get is the Ids for the QuestByName functions. For them, I need to get the Ids of quests in an npc dialog. I could only come up with that other solution. It would be preferable to be able to use Ids but I can't see how to do it.

[rock5]

I think I've thought of a way of doing it.

I was thinking of adding support for Ids. It would just convert the Ids to names using GetIdName. This is so it is easier to create multilingual scripts. But then I thought what if I could also get the quest group from memory for that Id as well? Then, with the name and quest group, I'd be able to match 100% the quest without the need for the second option. This assumes I'll be able to get the group from memory.

Unless users would like the option to, for instance, accept all normal quests.

[rock5]

This assumes I'll be able to get the group from memory.

I'm not having much luck. Looks like I might leave it at it is although I might still add the basic support for Ids.

[rock5]

I was wrong. I have found the quest group in memory.

That means we can reliably use the Ids in the QuestByName functions like so,

Code: Select all

AcceptQuestByName(424171)

The last question is, should I add the group argument anyway so that you can accept/complete specific types of quests? Example

Code: Select all

AcceptAllQuests("normal")

Would people want this option? I guess it wouldn't hurt to add it anyway, especially as I've already written it.

[rock5]

I've committed the above discussed changes. Read about them here.
http://www.solarstrike.net/phpBB3/viewt ... 728#p40728

I've also updated this userfunction version of getQuestStatus to accept Ids as well.

[dx876234]

For KillGoals and ItemGoals, would it be an idea to have the goalCount available together with the NumReq? Hmm perhaps not really nessesary for ItemGoals as an inventory:itemTotalCount would do the trick but for KillGoals it would be nice.

-dx

[dx876234]

I've added one line to the update function which implements GoalCount:

Code: Select all

					end
					self.KillGoals[i].NumReq    = memoryReadUInt(getProc(), self.BaseItemAddress + 0x1B8 + 0x4 * (i - 1))
					self.KillGoals[i].GoalCount = memoryReadByte(getProc(), self.Address + 4 + i)					
				end
			until id == 0 or i == 5

regards
DX

[rock5]

For KillGoals and ItemGoals, would it be an idea to have the goalCount available together with the NumReq? Hmm perhaps not really nessesary for ItemGoals as an inventory:itemTotalCount would do the trick but for KillGoals it would be nice.

The reason I didn't add it is because the only need for it is to know if the quest is complete. So it only needs to get that value when you are checking the quest status. Why get that information if you are not checking the quests status? So in fact the quest log hold no information that changes. This makes updates quicker because if the quest hasn't changed, it doesn't need to be updated. This was intentional because a full questlog:update() would otherwise take too long.

Do you have some need for it? Why do you need it? How do you want to use it?

[dx876234]

Well, I was looking for ways to detect when I could stop following a cow in the cowboy event, this would be when a cow was in bin, i.e. when GoalCount increased.

In my ignorance there is probably other ways to detect this as well.

-dx

[rock5]

You could probably just check the possition of the cow. When it passes a certain point, it's there. Would that work?

[dx876234]

Tbh, simplest way is to check progress of the quest but if its a problem I dont need to put it into the userfile, can do the test directly in the waypoint.

-dx