Name
hw_HandleEvents -- handle events (V6.0)
Synopsis
int error = hw_HandleEvents(lua_State *L, ULONG flags, int *quit);
Function
This function reads all events that are currently in the queue and processes them. If there is an event that tells Hollywood to quit, the int pointer in the third parameter is set to True. Together with hw_WaitEvents() this function can be used to set up a temporary modal event loop.

The following flags are currently defined:

HWHEFLAGS_LINEHOOK:
This flag must be set if hw_HandleEvents() has been called from the Lua line hook. This should never be set by you.

HWHEFLAGS_MODAL:
This flag signals that hw_HandleEvents() has been called from a temporary modal event loop. You should always set this flag.

HWHEFLAGS_CHECKEVENT:
This flag is set if hw_HandleEvents() has been called as a result of the script calling Hollywood's CheckEvent() command. This should never be set by you.

HWHEFLAGS_WAITEVENT:
This flag is set if hw_HandleEvents() has been called as a result of the script calling Hollywood's WaitEvent() command. This should never be set by you.

HWHEFLAGS_RUNCALLBACKS:
This flag signals that hw_HandleEvents() should also run any event callbacks that have triggered. This is useful on plugins which don't install a display adapter and hence cannot use HWMSFLAGS_RUNCALLBACKS because hw_MasterServer() must only be called by display adapters. Use this flag only if you have a very good reason to do so. Normally, you should leave callback execution to Hollywood. It will run event callbacks whenever the script calls CheckEvent() or WaitEvent() and normally you shouldn't have intervene in this design. (V6.1)

Designer compatibility
Unsupported

Inputs
L
pointer to the lua_State
flags
combination of flags (see above)
quit
pointer to an int that is set to True if Hollywood shall quit
Results
error
error code or 0 for success

Show TOC