Skip to content

Adding more details to hooks and events to match modLoader changes #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DasKeifer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding more details to hooks and events to match modLoader changes #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions scripts/hooks.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,15 @@ function hooks:addTo(modApiExt)
local eventId = "on"..Name
local addHook = "add"..Name.."Hook"

events[eventId] = Event()
events[eventId] = Event({ eventName = eventId })

modApiExt[hookId] = {}
modApiExt[addHook] = function(self, fn)
assert(type(fn) == "function")
table.insert(self[hookId], fn)
table.insert(self[hookId], {
fn = fn,
creator = debug.traceback("", 3)
})
end

-- functions to fire the hooks are built in internal.lua
Expand Down
31 changes: 21 additions & 10 deletions scripts/internal.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
local internal = {}

function internal.handleFailure(errorOrResult, creator, caller)
errorOrResult = errorOrResult or "<unspecified error>"
local message = Event.buildErrorMessage("An event callback failed: ", errorOrResult,
nil, creator, caller)
if Event.isStackOverflowError(errorOrResult) then
error(message)
else
LOG(message)
end
end

--[[
Creates a broadcast function for the specified hooks field, allowing
to trigger the hook callbacks on all registered modApiExt objects.
Expand All @@ -10,14 +21,15 @@ local internal = {}
--]]
function internal:buildBroadcastFunc(hooksField, argsFunc)
local errfunc = function(e)
return string.format(
"A '%s' callback has failed:\n%s",
hooksField, e
)
-- Capture and return the stack trace of the xpcall
-- 2 makes it start a frame higher so it doesn't include
-- this error handling fn
return debug.traceback(tostring(e), 2)
end

return function(...)
local args = {...}
local caller = debug.traceback("")

if #args == 0 then
-- We didn't receive arguments directly. Fall back to
Expand All @@ -28,19 +40,18 @@ function internal:buildBroadcastFunc(hooksField, argsFunc)

for i, extObj in ipairs(modApiExt_internal.extObjects) do
if extObj[hooksField] then
for j, hook in ipairs(extObj[hooksField]) do
for j, hookTbl in ipairs(extObj[hooksField]) do
-- invoke the hook in a xpcall, since errors in SkillEffect
-- scripts fail silently, making debugging a nightmare.
local ok, err = xpcall(
local ok, errorOrResult = xpcall(
args
and function() hook(unpack(args)) end
or function() hook() end,
and function() hookTbl.fn(unpack(args)) end
or function() hookTbl.fn() end,
errfunc
)

if not ok then
local owner = extObj.owner and extObj.owner.id or "<unknown>"
LOG("In mod id '" .. owner .. "', ", err)
internal.handleFailure(errorOrResult, hookTbl.creator, caller)
end
end
end
Expand Down