Returns the current event message type from the global event state.
Takes no parameters.
Returns the value of the global variable LuiEvent.
BGI GUI
Parameters & Returns
Parameters
This function takes no parameters.
Returns
Int
Quick Summary
Returns the current event message type from the global event state.
Takes no parameters.
Returns the value of the global variable LuiEvent.
Technical Exegesis...
Returns the current event message type from the global event state. Returns the value of the global variable LuiEvent. Event message types are: BGI_EVENT_COMMAND_CLOSE (0x001) for window close events, BGI_EVENT_COMMAND_CLICK (0x002) for click events (buttons, menu items, links), and BGI_EVENT_COMMAND_UPDATE (0x003) for value change events (trackbars, spinners, textboxes, lists). Returns 0 when no event is pending or after bgiFlushEvent is called.
Returns the current event message type from the global event state. Returns the value of the global variable LuiEvent. Event message types are: BGI_EVENT_COMMAND_CLOSE (0x001) for window close events, BGI_EVENT_COMMAND_CLICK (0x002) for click events (buttons, menu items, links), and BGI_EVENT_COMMAND_UPDATE (0x003) for value change events (trackbars, spinners, textboxes, lists). Returns 0 when no event is pending or after bgiFlushEvent is called.
This function retrieves the high-level event category - what kind of interaction occurred. The LuiEvent global is set by the BGI event system when Windows messages are processed. COMMAND_CLOSE fires when windows are closed. COMMAND_CLICK fires for discrete actions (button press, menu selection). COMMAND_UPDATE fires for control value changes (slider moved, text edited, selection changed). Use this as the first check in event processing loops. Common pattern: if bgiGetEventMessage() == BGI_EVENT_COMMAND_CLICK, then check bgiGetEventID() to determine which control type, then bgiGetEventSource() for specific control.