diff options
| -rw-r--r-- | DOCS/man/lua.rst | 18 | ||||
| -rw-r--r-- | player/lua/defaults.lua | 27 |
2 files changed, 41 insertions, 4 deletions
diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index 88fb4cb7ce..3fdb0b2f42 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -889,8 +889,22 @@ guarantee a stable interface. their result (normally, the Lua scripting interface is asynchronous from the point of view of the player core). ``priority`` is an arbitrary integer that allows ordering among hooks of the same kind. Using the value 50 is - recommended as neutral default value. ``fn`` is the function that will be - called during execution of the hook. + recommended as neutral default value. + + ``fn(hook)`` is the function that will be called during execution of the + hook. The parameter passed to it (``hook``) is a Lua object that can control + further aspects about the currently invoked hook. It provides the following + methods: + + ``defer()`` + Returning from the hook function should not automatically continue + the hook. Instead, the API user wants to call ``hook:cont()`` on its + own at a later point in time (before or after the function has + returned). + + ``cont()`` + Continue the hook. Doesn't need to be called unless ``defer()`` was + called. See `Hooks`_ for currently existing hooks and what they do - only the hook list is interesting; handling hook execution is done by the Lua script diff --git a/player/lua/defaults.lua b/player/lua/defaults.lua index 72920cea67..95f8952f5d 100644 --- a/player/lua/defaults.lua +++ b/player/lua/defaults.lua @@ -547,12 +547,35 @@ end local hook_table = {} +local hook_mt = {} +hook_mt.__index = hook_mt + +function hook_mt.cont(t) + if t._id == nil then + mp.msg.error("hook already continued") + else + mp.raw_hook_continue(t._id) + t._id = nil + end +end + +function hook_mt.defer(t) + t._defer = true +end + mp.register_event("hook", function(ev) local fn = hook_table[tonumber(ev.id)] + local hookobj = { + _id = ev.hook_id, + _defer = false, + } + setmetatable(hookobj, hook_mt) if fn then - fn() + fn(hookobj) + end + if (not hookobj._defer) and hookobj._id ~= nil then + hookobj:cont() end - mp.raw_hook_continue(ev.hook_id) end) function mp.add_hook(name, pri, cb) |