Module: Metro::HasEvents::ClassMethods

Defined in:
lib/metro/events/has_events.rb

Instance Method Summary collapse

Instance Method Details

#event(event_type, *args, &block) ⇒ Object

Register an event for the scene.

Here in this scene if the Escape Key is pressed and released the example scene will transition to the title scene.

Here in this scene if the GpLeft or GpUp buttons are pressed down the method ‘previous_options` will be executed.

This example uses a block instead of a method name but it is absolultey the same as the last example.

Examples:

Registering for a save complete event that would re-enable a menu.


class ExampleScene
  event :notification, :save_complete do
    menu.enabled!
  end
end

Registering for button held events


class ExampleScene
  event :on_hold KbLeft, GpLeft do
    player.turn_left
  end

  event :on_hold, KbRight, GpRight do
    player.turn_right
  end

  event :on_hold, KbUp, GpButton0, do: :calculate_accleration

  def calculate_acceleration
    long_complicated_calculated_result = 0
    # ... multi-line calculations to determine the player acceleration ...
    player.accelerate = long_complicated_calculated_result
  end
end

Registering for a button down event to call a method named ‘next_option’


class ExampleScene
   event :on_up, KbEscape, do: :leave_scene

  def leave_scene
    transition_to :title
  end
end

Registering for a button up event with a block of code to execute


class ExampleScene
  event :on_up, KbEscape do
   transition_to :title
  end
end

Registering for a button down event to call a method named ‘previous_option’


class ExampleScene
  event :on_down, GpLeft, GpUp, do: :previous_option

  def previous_option
    @selected_index = @selected_index - 1
    @selected_index = options.length - 1 if @selected_index <= -1
  end
end

Registering for a button down event with a block of code to execute


class ExampleScene
   event :on_down, GpLeft, GpUp do
    @selected_index = @selected_index - 1
    @selected_index = options.length - 1 if @selected_index <= -1
  end
end


93
94
95
 
# File 'lib/metro/events/has_events.rb', line 93

def event(event_type,*args,&block)
  EventDictionary.add target: metro_name, type: event_type, args: args, block: block
end

#events ⇒ Object

Returns a list of all the EventFactories defined for this event holding object.

Returns:

  • a list of all the EventFactories defined for this event holding object



100
101
102
 
# File 'lib/metro/events/has_events.rb', line 100

def events
  EventDictionary.events_for_targets(hierarchy)
end