mutators: enable/disable sequence

vmf_source/scripts/mods/vmf/modules/core/toggling.lua

@@ -52,13 +52,11 @@ VMFMod.enable = function (self)
   end
 end
 
-VMFMod.init_state = function (self)
-
-  if _DISABLED_MODS_LIST[self:get_name()] then
-    change_mod_state(self, false, true)
-  else
-    change_mod_state(self, true, true)
+VMFMod.init_state = function (self, state)
+  if type(state) ~= "boolean" then 
+    state = not _DISABLED_MODS_LIST[self:get_name()]
   end
+  change_mod_state(self, state, true)
 end
 
 -- ####################################################################################################################

vmf_source/scripts/mods/vmf/modules/mutators.lua

@@ -0,0 +1,181 @@
+local vmf = get_mod("VMF")
+
+local mutators = {}
+local mutators_sequence = {}
+local mutators_sorted = false
+
+local function update_mutators_sequence(mod_name, load_these_after)
+	if not mutators_sequence[mod_name] then
+		mutators_sequence[mod_name] = {}
+	end
+	for _, mutator_name in ipairs(load_these_after) do
+		if not table.has_item(mutators_sequence[mod_name], mutator_name) then
+			table.insert(mutators_sequence[mod_name], mutator_name)
+		end
+	end
+	table.combine(mutators_sequence[mod_name], load_these_after)
+end
+
+local function sort_mutators()
+
+	vmf:dump(mutators_sequence, "seq", 5)
+	for i, v in ipairs(mutators) do
+		print(i, v:get_name())
+	end
+	print("-----------")
+
+	local i = 2
+	while i <= #mutators do
+		local mutator = mutators[i]
+		local mutator_name = mutator:get_name()
+		local load_these_after = mutators_sequence[mutator_name] or {}
+
+		local j = i - 1
+		while j > 0 do
+			local other_mutator = mutators[j]
+			if table.has_item(load_these_after, other_mutator:get_name()) then
+				table.remove(mutators, j)
+				table.insert(mutators, i, other_mutator)
+				i = i - 1
+			end
+			j = j - 1
+		end
+
+		i = i + 1
+	end
+	mutators_sorted = true
+
+	for i, v in ipairs(mutators) do
+		print(i, v:get_name())
+	end
+	print("-----------")
+end
+
+local function set_mutator_state(self, state)
+	local i = table.index_of(mutators, self)
+	if i == nil then
+		self:error("Mutator isn't in the list")
+		return
+	end
+
+	if not mutators_sorted then
+		sort_mutators()
+	end
+
+	local disabled_mutators = {}
+	local load_these_after = mutators_sequence[self:get_name()]
+
+	if load_these_after and #mutators > i then
+		for j = #mutators, i + 1, -1 do
+			if mutators[j]:is_enabled() and table.has_item(load_these_after, mutators[j]:get_name()) then
+				print("Disabled ", mutators[j]:get_name())
+				mutators[j]:disable()
+				table.insert(disabled_mutators, 1, mutators[j])
+			end
+		end
+	end
+
+	if state then
+		print("Enabled ", self:get_name(), "!")
+		VMFMod.enable(self)
+	else
+		print("Disabled ", self:get_name(), "!")
+		VMFMod.disable(self)
+	end
+
+	if #disabled_mutators > 0 then
+		for j = #disabled_mutators, 1, -1 do
+			print("Enabled ", disabled_mutators[j]:get_name())
+			disabled_mutators[j]:enable()
+		end
+	end
+	print("---------")
+end
+
+local function enable_mutator(self)
+	vmf:pcall(function() set_mutator_state(self, true) end)
+end
+
+local function disable_mutator(self)
+	vmf:pcall(function() set_mutator_state(self, false) end)
+end
+
+VMFMod.register_as_mutator = function(self, config)
+	if not config then config = {} end
+
+	local mod_name = self:get_name()
+
+	if table.has_item(mutators, self) then
+		self:error("Mod is already registered as mutator")
+		return
+	end
+
+	table.insert(mutators, self)
+
+	if config.enable_before_these then
+		update_mutators_sequence(mod_name, config.enable_before_these)
+	end
+
+	if config.enable_after_these then
+		for _, other_mod_name in ipairs(config.enable_after_these) do
+			update_mutators_sequence(other_mod_name, {mod_name})
+		end
+	end
+
+	self.enable = enable_mutator
+	self.disable = disable_mutator
+
+	mutators_sorted = false
+
+	-- Always init in the off state
+	self:init_state(false)
+end
+
+-- Testing
+local mutator1 = new_mod("mutator1")
+local mutator2 = new_mod("mutator2")
+local mutator3 = new_mod("mutator3")
+local mutator555 = new_mod("mutator555")
+local mutator_whatever = new_mod("mutator_whatever")
+
+mutator555:register_as_mutator({
+	enable_after_these = {
+		"mutator1"
+	}
+})
+mutator555:create_options({}, true, "mutator555", "mutator555 description")
+mutator555.on_enabled = function() end
+mutator555.on_disabled = function() end
+
+mutator2:register_as_mutator({
+	enable_before_these = {
+		"mutator555",
+		"mutator3"
+	}
+})
+mutator2:create_options({}, true, "mutator2", "mutator2 description")
+mutator2.on_enabled = function() end
+mutator2.on_disabled = function() end
+
+mutator1:register_as_mutator({
+	enable_before_these = {
+		"mutator2"
+	}
+})
+mutator1:create_options({}, true, "mutator1", "mutator1 description")
+mutator1.on_enabled = function() end
+mutator1.on_disabled = function() end
+
+mutator3:register_as_mutator({
+	enable_before_these = {
+		"mutator555"
+	}
+})
+mutator3:create_options({}, true, "mutator3", "mutator3 description")
+mutator3.on_enabled = function() end
+mutator3.on_disabled = function() end
+
+mutator_whatever:register_as_mutator()
+mutator_whatever:create_options({}, true, "mutator_whatever", "mutator_whatever description")
+mutator_whatever.on_enabled = function() end
+mutator_whatever.on_disabled = function() end

vmf_source/scripts/mods/vmf/vmf_loader.lua

@@ -21,6 +21,8 @@ return {
 		dofile("scripts/mods/vmf/modules/options_menu/vmf_options_view")
 		dofile("scripts/mods/vmf/modules/vmf_options")
 
+		dofile("scripts/mods/vmf/modules/mutators")
+
 		object.vmf = get_mod("VMF")
 
 		-- temporary solution: