Topic       : The GFA-Basic Compendium
Author      : GFA Systemtechnik GmbH
Version     : GFABasic.HYP v2.98 (12/31/2023)
Subject     : Documentation/Programming
Nodes       : 899
Index Size  : 28056
HCP-Version : 3
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Document not found
@help       : Help
@options    : +g -i -s +z
@width      : 75
@hostname   : STRNGSRV
@hostname   : CAB     
@hostname   : HIGHWIRE
@hostname   : THING   
View Ref-FileEVNT_MULTI(flag,clicks,mask,state,
m1_flags,m1_x,m1_y,m1_w,m1_h,m2_flags,m2_x,m2_y,m2_w,m2_h,
adr_buffer,count[,mcur_x,mcur_y,button,k_state,key,num_clicks])

flag, clicks, mask, state: iexp
m1_flags, m1_x, m1_y, m1_w, m1_h: iexp
m2_flags, m2_x, m2_y, m2_w, m2_h: iexp
adr_buffer, count: iexp
mcur_x, mcur_y, button, k_state, key, num_clicks: ivar

Waits for the occurrence of selected events.

Returns the event which actually occured (see 'flag' below).

    flag       - Sets the events to be awaited as follows:
                 Bit 0: Keyboard            MU_KEYBD
                 Bit 1: Mouse button        MU_BUTTON
                 Bit 2: First mouse event   MU_M1
                 Bit 3: Second mouse event  MU_M2
                 Bit 4: Message event       MU_MESAG
                 Bit 5: Timer               MU_TIMER
    num_clicks - Returns the number of mouse clicks.

The parameters were already described for EVNT_BUTTON(), EVNT_KEYBD(),
EVNT_MESAG(), and EVNT_MOUSE(). However, it should be noted that two different
mouse events (m1 and m2) can be awaited. With ON MENU, which uses this routine
internally, the parameters are installed for the instruction ON MENU xxx GOSUB,
e.g. 'count' is specified directly.

The parameters mcur_x, mcur_y, button, k_state, key, and num_clicks are
optional, these values can also be found by querying GINTOUT(1) to GINTOUT(6).

    MENU(1) to MENU(8)   Message buffer
    MENU(9)              Return value
    MENU(10)=mcur_x      x mouse position
    MENU(11)=mcur_y      y mouse position
    MENU(12)=button      Mouse button state
    MENU(13)=k_state     'Shift' key state (BIOS(11,-1))
    MENU(14)=key         ASCII and Scan code
    MENU(15)=num_clicks  Number of mouse clicks

evnt_multi()+, MU_MESAG+