Quests moved to Lua

[MillhioreBT]

Pull Request Prelude

• I have followed [proper The Forgotten Server code styling][code].
• I have read and understood the [contribution guidelines][cont] before making this PR.
• I am aware that this PR may be closed if the above-mentioned criteria are not fulfilled.

Changes Proposed

• Moved the Quest and Mission system to Lua completely.
• No compatibility with the old quests.xml file (If someone wants to do it in another PR, they can do it with the help of these methods included in this PR Add XML parsing bindings for Lua #4108)
• The Quest Tracker of each player that is tracking a quest will be reset if you use /reload scripts or all (This is because we don't want ghost quests that have been removed, changed, or replaced.)
• To make this possible, 4 new events have been created: (onStorageUpdate, onQuestTracker, onQuestLog, onQuestLine

If you have suggestions or find any bugs please let me know, I've tested it, but your revisions are always needed.

Issues addressed: Nothing!

[ranisalt]

This is great. Feels like moving forward.

[DSpeichert]

LGTM on dropping XML support here, I don't think it made sense to have it so I won't be pushing for backwards compatibility on this.

[MillhioreBT]

LGTM on dropping XML support here, I don't think it made sense to have it so I won't be pushing for backwards compatibility on this.

Here the example of the xml reader from lua for compatibility with previous versions.

load_questsxml.lua

local questXml = XMLDocument("data/XML/quests.xml")
local child = questXml:child("quests")
local firstChild = child:firstChild()

while firstChild do
	local missionNode = firstChild:firstChild()
	local missions = {}
	while missionNode do
		local mission = {
			name = missionNode:attribute("name"),
			storageId = missionNode:attribute("storageid"),
			startValue = missionNode:attribute("storagevalue"),
			endValue = missionNode:attribute("endvalue"),
			ignoreEndValue = missionNode:attribute("ignoreendvalue"),
			description = missionNode:attribute("description")
		}

		if not mission.description then
			local missionState = missionNode:firstChild()
			local description = {}
			while missionState do
				description[missionState:attribute("id")] = missionState:attribute("description")
				missionState = missionState:nextSibling()
			end

			mission.description = description
		end

		missions[#missions + 1] = mission
		missionNode = missionNode:nextSibling()
	end

	Game.createQuest(firstChild:attribute("name"), {
		storageId = firstChild:attribute("startstorageid"),
		storageValue = firstChild:attribute("startstoragevalue"),
		missions = missions
	}):register()

	firstChild = firstChild:nextSibling()
end

It's basically placed in some .lua file in the data\scripts folder and now we have backwards compatibility again, should I add it to this PR?

[EPuncker]

lets go

[EPuncker]

needs rebase and will be merged

[omarcopires]

Works fine for me:

[ranisalt]

TrackedQuests is a bad name, makes it look like you are constructing a new value, but it's just a function. getTrackedQuests maybe? And you don't need to return trackeds just use #trackedQuests

[ranisalt]

getQuests does not return all quests so it should be clear about it. getPlayerQuests

Also, I think it should be in the Game or Player namespace, not Quest

[ranisalt]

I would change these event names to be more explicit about what they are reacting to:

Suggested change

	<event class="Player" method="onQuestTracker" enabled="1" />
	<event class="Player" method="onQuestLog" enabled="1" />
	<event class="Player" method="onQuestLine" enabled="1" />
	<event class="Player" method="onRequestQuestTracker" enabled="1" />
	<event class="Player" method="onRequestQuestLog" enabled="1" />
	<event class="Player" method="onRequestQuestLine" enabled="1" />

Or open instead of request. All other events are (or should be) in the format on<action><subject>

Also, onStorageUpdate -> onUpdateStorage. onInventoryUpdate is incorrect.

[ranisalt]

These belong to Game or Player, no need to create metatables. Game.getQuestById(id), Player.getTrackedQuests() then Quest.getMissionById(id)

[ranisalt]

I think these can be removed if you move the packet parsing to Lua :)

[MillhioreBT]

yeah <3

[MillhioreBT]

Closed for inconsistency, I will reopen it in another PR already refactored and applying the suggestions mentioned here