DebugWwiseWorld.lua

--[[
	author: Aussiemon

	-----

	Copyright 2017 Aussiemon

	Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

	The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

	-----

	Reports and outputs the name of every sound event that plays.
--]]

local mod_name = "DebugWwiseWorld"
local mod = {}

-- ##########################################################
-- ################## Variables #############################

local file_path = "WwiseEvents.csv"

-- ##########################################################
-- ################## Functions #############################

local writeToFile = function(output)
	local file = io.open(file_path, "a+")
	if not file then
		return
	end

	if type(output) ~= "string" then
		output = tostring(output)
	end

	file:write(output.."\n")
	io.close(file)
end

-- ##########################################################
-- #################### Hooks ###############################

local event_table = {}
Mods.hook.set(mod_name, "WwiseWorld.trigger_event", function (func, self, event_name, ...)
	local result = func(self, event_name, ...)

	if not event_table[event_name] then
		event_table[event_name] = true

		EchoConsole(event_name)

		local level_key = "loading"
		if Managers and Managers.state and Managers.state.game_mode then
			level_key = Managers.state.game_mode:level_key() or "loading"
		end
		writeToFile(tostring(level_key)..","..tostring(event_name))
	end

	return result
end)

-- ##########################################################
-- ################### Script ###############################

EchoConsole("Debug WWise World mod enabled...")

-- ##########################################################