Daily Archives: December 14, 2013

SP_RAT_LEFTB

Posted on by vivaclipper

 RAT_LEFTB() Determines if the left mouse button has been

 pressed

 Returns
 <lHasBeenPressed> => left mouse button has been
 pressed

 Syntax
 RAT_LEFTB()

 Description
 This returns .t. if the left button has been pressed
 since last call to this function. Row and column are recorded
 for reference by rat_rowl() and rat_coll().

 Examples
  if rat_leftb()

    ?"While you were out:"

    ?"Left button was depressed at"

    ??rat_rowl(),rat_coll()

  endif

 Notes:
 This is different from RAT_LBHD() in that RAT_LBHD()
 is a 'right now' function - determining if the button IS
 depressed, whereas this function determines if the button HAS
 been depressed.

 Source: S_MOUSE.ASM

 

SP_RAT_LBHD

Posted on by vivaclipper 
RAT_LBHD() Determines if the mouse left button is currently
 depressed

 Returns
 <lDepressed> => mouse left button is currently
 depressed

 Syntax
 RAT_LBHD()

 Description
 Determines if the mouse left button is currently
 depressed

 Examples
  if RAT_LBHD()
    ?"Mouse left button depressed NOW"
  endif

 Notes:
 This is different from the event function
 RAT_ELBHD(). RAT_ELBHD(<n>) watches the mouse for <n> seconds,
 and if the mouse remains depressed for the full time, then it is
 considered to be HELD DOWN. RAT_LBHD() on the other hand, only
 checks for the mouse button being depressed RIGHT NOW.
 RAT_ELBHD() calls RAT_LBHD() repetitively.

 Source: S_MOUSE.ASM

 

SP_RAT_EXIST

Posted on by vivaclipper 
RAT_EXIST() Determines if a mouse is available

 Returns
 <lExists> => mouse is available

 Syntax
 RAT_EXIST()

 Description
 This tells if a mouse is present, and mouse driver
 software is loaded. The mouse state is not changed.

 Examples
  if rat_exist()
    * do some mouse stuff
  else
    * don't do some mouse stuff
  endif

 Notes:
 Many mouse libraries use a call to Interrupt 33,
 service 0 to determine if a mouse is present. This has the
 unpleasant effect of  resetting the mouse to its defaults. This blows away
 mouse position,  cursor and other nifty things that may have been set.

 This function uses another means to determine if a
 mouse is present,  and does not reset the mouse or damage any mouse
 settings, thus you can use it with other mouse-oriented libraries
 without dire consequences.

 Source: S_MOUSE.ASM

SP_RAT_COLR

Posted on by vivaclipper 
RAT_COLR() Returns mouse column at the last right button
 press

 Returns
 <nColumn> => mouse column at last right button press

 Syntax
 RAT_COLR()

 Description
 Returns mouse column at the last right button press

 (as recorded by a call to rat_rightb() )

 Examples
  if rat_rightb()

    ?"While you were out:"

    ?"Right button was depressed at"

    ??rat_rowr(),rat_colr()

  endif

 Notes:
 This is different from RAT_COL() in that RAT_COL()
 tells the mouse row NOW whereas RAT_COLR() tells where the mouse
 was at the last recorded right button press (as recorded by a
 call to rat_rightb() )

 Source: S_MOUSE.ASM

SP_RAT_COLL

Posted on by vivaclipper 
RAT_COLL() Returns mouse column at the last left button press

 Returns
 <nColumn> => mouse column at last left button press

 Syntax
 RAT_COLL()

 Description
 Returns mouse column at the last left button press

 (as recorded by a call to rat_leftb() )

 Examples
  if rat_leftb()

    ?"While you were out:"

    ?"Left button was depressed at"

    ??rat_rowl(),rat_coll()

  endif

 Notes:
 This is different from RAT_COL() in that RAT_COL()
 tells the mouse row NOW whereas RAT_COLL() tells where the mouse
 was at the last recorded left button press (as recorded by a
 call to rat_leftb() )

 Source: S_MOUSE.ASM

SP_RAT_COL

Posted on by vivaclipper 
 RAT_COL() Current mouse column

 Returns :
 <nRow> => mouse column right now

 Syntax :  RAT_COL()

 Description : This gives the CURRENT mouse column

 Examples :   
   ? "Mouse is at column :",rat_col()

 Notes:
 This is different from RAT_COLL() or RAT_COLR() in
 that these two functions return the recorded column when the
 mouse button was last pressed, (RAT_COLL() for left or
 RAT_COLR() for right).

 This function tells where the mouse is right now.

 Source: S_MOUSE.ASM

 

SP_RAT_AREA

Posted on by vivaclipper

 RAT_AREA() Limits the mouse to a rectangular area of the screen

 Returns  None

 Syntax  RAT_AREA(nTop,nLeft,nBottom,nRight)

 Description

 Limits the mouse to a rectangular area of the screen
 determined by <nTop,nLeft,nBottom,nRight>. Mouse cannot move
 outside of these boundaries.

 Examples

  RAT_AREA(10,10,20,20) // limits the mouse to 10,10,20,20 area

 Notes:

 Be sure to set the mouse area back to fullscreen when
 you're done.

 Source: S_MOUSE.ASM