Major events update

GameState:doneEvent is updated to allow incrementing the used count (which is returned), and it is automatically called for events that are placed or assigned to a level, allowing event code to check the count correctly.

GameState:startEvents() updated:

The zone events file supports some new fields:

unique = true prevents triggering of events that have previously been triggered (anywhere in the game)

level_range = a range of allowed levels the event is allowed to spawn on (complements the forbid field)

special = an optional function(lev) that can determine if the event should spawn or not (The logic is updated to be consistent with other "special" functions used in filters, etc.)

Fixed a bug in passing event_id to event functions (metatables).

Added documentation and output to the relevant GameState functions.

Fixed issues with major events that involve a change of zone (sub-vault, rat-lich, damp-cave, old-battle-field, drake-cave, naga-portal, fearscape-portal):

.no_worldport is set to that of the parent zone.

Actor levels are 5% to 15% higher than the parent zone and game difficulty adjustments are not compounded.

Object material levels match the parent zone.

Auto explore and minimap settings are updated.

This makes these events "safe" to add anywhere in the game and at higher difficulties, and they are added as standard to the I.D. (with appropriate level restrictions).

Fixed a bug in game:changeLevelReal that was causing the player to incorrectly be placed at level start when params.auto_level_stair was set. (Affected the old-battle-field event and some other stairs)

Other event changes:

The player can choose to ignore the naga-portal and fearscape-portal by hitting escape at the pop-up.

The cultists event uniqueness is fixed (unique across the game) and it can only spawn from level 15+ in the I.D.

Fixed a bug in the sub-vault event that was preventing the stairs from crumbling as intended.

Updated the sludgenest and noxious-caldera events for the wilderness and the conclave-vault event for the halfling ruins. (No game play change; the special field is removed as it's not needed.)

game/modules/tome/class/GameState.lua

@@ -2389,16 +2389,15 @@ function _M:startEvents()
 		local evts, mevts = {}, {}
 		for i, e in ipairs(game.zone.events) do
 			if e.name then -- add a single event to the events list
---print("[STARTEVENTS] Adding Event:", i, tostring(e.name))
 				if e.minor then	mevts[#mevts+1] = e else evts[#evts+1] = e end
 			elseif e.group then -- load events from a group file and add them to the events list
---print("[STARTEVENTS] loading events group", e.group)
+				--	print("[STARTEVENTS] loading events group", e.group)
 				local f, err = loadfile(self:eventBaseName("groups/", e.group))
 				if not f then error(err) end
 				setfenv(f, setmetatable({level=game.level, zone=game.zone}, {__index=_G}))
 				local list = f()
 				for j, ee in ipairs(list) do
---					print("[STARTEVENTS]\t\tAdding Group Event:", j, tostring(ee.name))
+				--	print("[STARTEVENTS]\t\tAdding Group Event:", j, tostring(ee.name))
 					if ee.name then
 						if e.percent_factor and ee.percent then ee.percent = math.floor(ee.percent * e.percent_factor) end
 						if e.forbid then ee.forbid = table.append(ee.forbid or {}, e.forbid) end
@@ -2415,9 +2414,6 @@ function _M:startEvents()
 			end
 		end
 
---table.set(game.zone, "debug", "evts", evts) -- debugging
---table.set(game.zone, "debug", "mevts", mevts) -- debugging
-
 		-- Randomize the order they are checked as
 		print("[STARTEVENTS] Zone compiled events list: one_per_level=", game.zone.events.one_per_level)
 		table.shuffle(evts)
@@ -2495,7 +2491,6 @@ function _M:startEvents()
 		end
 
 		game.zone.assigned_events = levels
---table.set(game.zone, "debug", "assigned_events", table.clone(levels, true))--debugging
 	end
 
 	-- return a wrapper function to load and run all assigned events files