Class Rubygame::EventTriggers::MousePressTrigger
In: lib/rubygame/event_triggers.rb
Parent: Object

MousePressTrigger is an event trigger which fires when a mouse button is pressed down (i.e. MousePressed).

By default, this trigger fires for any mouse press, but it can be configured to fire for only a specific mouse button by passing a button symbol to new.

See also MousReleaseTrigger.

Methods

match?   new  

Public Class methods

Initialize a new instance of MousePressTrigger with the given mouse button.

button:The mouse button symbol to detect, or :any to detect any button press.

Valid mouse button symbols are: :mouse_left, :mouse_middle, :mouse_right, :mouse_wheel_up, and :mouse_wheel_down.

[Source]

# File lib/rubygame/event_triggers.rb, line 525
        def initialize( button=:any )
                @button = button
        end

Public Instance methods

Returns true if the event is a MousePressed event and the event’s button is the same as the trigger’s button (or the trigger’s button is :any).

[Source]

# File lib/rubygame/event_triggers.rb, line 533
        def match?( event )
                if event.kind_of?( Rubygame::Events::MousePressed )
                        ((@button == :any) or (event.button == @button))
                else
                        false
                end
        end

[Validate]