Module: LiteRGSS::Mouse

Defined in:
LiteRGSS.rb

Overview

Module that helps to retreive Mouse information during the game time

The buttons of the mouse are : :LEFT (:left), :MIDDLE (:middle), :RIGHT (:right), :X1, :X2

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.wheelInteger

The vertical mouse wheel delta

Returns:

  • (Integer)

.xInteger (readonly)

Retreive the x mouse position on the screen

Returns:

  • (Integer)

.yInteger (readonly)

Retreive the y mouse position on the screen

Returns:

  • (Integer)

Class Method Details

.press?(sym) ⇒ Boolean

Tell if a button is pressed

Parameters:

  • sym (Symbol)

    symbol of the button

Returns:

  • (Boolean)

.released?(sym) ⇒ Boolean

Tell if a button has been released

Parameters:

  • sym (Symbol)

    symbol of the button

Returns:

  • (Boolean)

.trigger?(sym) ⇒ Boolean

Tell if a button has been triggered

Parameters:

  • sym (Symbol)

    symbol of the button

Returns:

  • (Boolean)