Document core.sendGlobalEvent behavior in menu scripts

11 months ago · 5d0537e57c
parent 02accd7a49
commit 5d0537e57c
1 changed files with 1 additions and 1 deletions
--- a/files/lua_api/openmw/core.lua
+++ b/files/lua_api/openmw/core.lua
@ -19,7 +19,7 @@
 -- @function [parent=#core] quit

 ---
-- Send an event to global scripts.
+-- Send an event to global scripts. Note: in menu scripts, errors if the game is not running (check @{openmw.menu#menu.getState})
 -- @function [parent=#core] sendGlobalEvent
 -- @param #string eventName
 -- @param eventData