metro 0.3.4 → 0.3.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmI2NDBlMjQ5MzRjZGM4ZTMwZmRkMGJjMDM3NDg2YzUwNGM4NmFmYw==
+  data.tar.gz: !binary |-
+    N2IwMTFlODhlYzg1ODZkMmU1MzJiNDRkMTQ3Y2Q2ZTc2MWYyMzM5MQ==
+SHA512:
+  metadata.gz: !binary |-
+    NzI4ZDMyOTBhZTdlOTcwYjgwMWQ3NDJiNWVlZTllNmNlYTY0YWI3ODc5YWNj
+    NGMzMmEwODY2YjBlYjkzMTkxZjUyMWJmNDYxYTMxZDlhOWQ2NjQ4OGIxMDBm
+    OTEwYTM0OTA3ODExNDVhNGFkYTkxNjFjOWU5MjViZWVkMTYyZmY=
+  data.tar.gz: !binary |-
+    NjI1ZDY5MDMxNjNkZWU3NzQ5MjBhOTVmMTY2YzM2NWM3MzRmYzY4MWIzYTFj
+    NmRmYTBkOGE0OGI5ZWVlZTFhMmE0ZjljYjFhNzNjZjI4N2NlNTI1MGM2MjJl
+    OTEwODhiMTI5Y2UyMDYyZDg2NmI1MjYyNmU4NjJkZTdkMzg4N2E=

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in metro.gemspec
 gemspec
 
+gem 'chipmunk'
+
 gem 'rake'
 
 group 'development' do

data/README.md

@@ -1,11 +1,4 @@
-```
-  ______  ___      _____
-  ___   |/  /_____ __  /_______________
-  __  /|_/ / _  _ \_  __/__  ___/_  __ \
-  _  /  / /  /  __// /_  _  /    / /_/ /
-  /_/  /_/   \___/ \__/  /_/     \____/
-
-```
+![Metro Image](metro.png)
 
 Metro is a framework built around [gosu](https://github.com/jlnr/gosu) (the 2D
 game development library in Ruby). The goal of Metro is to enforce common
@@ -133,19 +126,25 @@ Creating a Game can be done with a single command.
 $ metro new GAMENAME
 ```
 
-This should generate for you a starting game with a branding scene and a title
-scene. The game allows the player to start the game.
+This should generate for you a starting game with a branding scene, title
+scene and first game scene. The game allows the player to start the game.
 
-The game is missing the `first` scene of the game. This can be created with the
-scene generator:
+## Resources
 
-```bash
-$ metro generate scene first
-```
+### Metro Documentation
 
-This should generate a scene in the scenes directory. The scene file contains a lot of examples of how to draw, animate and have your scene listen to events.
+The Metro [wiki](../../wiki) contains lots of documentation:
 
-## Resources
+* [Game Configuration](wiki/game-configuration)
+* [Scenes](../../wiki/scenes)
+* [Views](../../wiki/views)
+* [Animations](../../wiki/animations)
+* [Scene Transitions](../../wiki/transitions)
+* [Models](../../wiki/models)
+* [Metro Models](../../wiki/metro-models)
+* [Model Properties](../../wiki/properties)
+* [Events](../../wiki/events)
+* [Units](../../wiki/units)
 
 ### Programming
 
@@ -155,7 +154,7 @@ This should generate a scene in the scenes directory. The scene file contains a
 ### Art
 
 * [Lost Garden](http://www.lostgarden.com/2007/05/dancs-miraculously-flexible-game.html)
-* [TimelieFX](http://www.rigzsoft.co.uk/) particle editor allows you to export animations.
+* [TimelineFX](http://www.rigzsoft.co.uk/) particle editor allows you to export animations.
 * [Text to ASCII Art Generator](http://patorjk.com/software/taag)
 * [Icons](http://css-tricks.com/flat-icons-icon-fonts/)
 * [Subtle Patterns](http://subtlepatterns.com/) various backgrounds and textures.
@@ -175,4 +174,4 @@ This should generate a scene in the scenes directory. The scene file contains a
 * [Challenges For Game Designers](http://www.amazon.com/dp/158450580X)
 * [The Art of Game Design: A book of lenses](http://www.amazon.com/dp/0123694965)
 * [A Theory of Fun](http://www.theoryoffun.com)
-* [Andrew Rollings and Ernest Adams on Game Design](http://www.amazon.com/dp/1592730019)
+* [Andrew Rollings and Ernest Adams on Game Design](http://www.amazon.com/dp/1592730019)

data/changelog.md

@@ -1,12 +1,16 @@
 # Metro
 
+## 0.3.5 / 2014-08-11
+
+* FIX active_support is now activesupport
+
 ## 0.3.4 / 2012-12-14
 
 * `metro::ui::sprite` and `metro::ui::animated_sprite` model classes
   to make it easier to take care of all the basic model attributes.
 * Event Management changed in the background. The API remains the
   same.
-  
+
 ## 0.3.3 / 2012-11-28
 
 * Edit Mode - actors within a scene can have their position edited

data/lib/core_ext/numeric.rb

@@ -56,4 +56,21 @@ class Numeric
 
   alias_method :ticks, :tick
 
+  def radians
+    self
+  end
+
+  def degrees
+    self
+  end
+
+  # Convert the specified numeric value in radians to degrees
+  def to_degrees
+    self * 180 / Math::PI
+  end
+
+  # Convert the specified numeric value in degrees to radians
+  def to_radians
+    self * Math::PI / 180
+  end
 end

data/lib/metro.rb

@@ -4,6 +4,9 @@ require 'erb'
 require 'open3'
 
 require 'gosu'
+require 'chipmunk'
+require 'texplay'
+require 'tmx'
 require 'i18n'
 require 'listen'
 require 'active_support'
@@ -12,10 +15,12 @@ require 'active_support/inflector'
 require 'active_support/core_ext/hash'
 require 'active_support/hash_with_indifferent_access'
 
-require 'gosu_ext/color'
-require 'gosu_ext/gosu_constants'
 require 'core_ext/numeric'
 require 'core_ext/class'
+require 'gosu_ext/color'
+require 'gosu_ext/gosu_constants'
+require 'tmx_ext/tile_set'
+require 'tmx_ext/object'
 
 require 'locale/locale'
 
@@ -132,7 +137,7 @@ module Metro
 end
 
 require 'setup_handlers/move_to_game_directory'
-require 'setup_handlers/load_game_files'
 require 'setup_handlers/load_game_configuration'
+require 'setup_handlers/load_game_files'
 require 'setup_handlers/exit_if_dry_run'
 require 'setup_handlers/reload_game_on_game_file_changes'

data/lib/metro/animation/on_update_operation.rb

@@ -39,14 +39,14 @@ module Metro
     # Perform a step of an animation, if it hasn't already been completed.
     #
     def update
-      return if completed?
+      return if update_completed?
 
       execute_step
       next_step
 
-      complete! if completed?
+      complete! if update_completed?
     end
-    
+
     #
     # @return the current step of the animation.
     #
@@ -67,12 +67,12 @@ module Metro
     def step_interval
       1
     end
-    
-    # 
+
+    #
     # @return true if the animation has completed all the actions, false
     #   if there are remaining actions.
-    # 
-    def completed?
+    #
+    def update_completed?
       current_step >= interval
     end
 

data/lib/metro/events/event_relay.rb

@@ -66,6 +66,7 @@ module Metro
       @up_actions ||= {}
       @down_actions ||= {}
       @held_actions ||= {}
+      @mouse_movement_actions ||= []
       @custom_notifications ||= HashWithIndifferentAccess.new([])
     end
 
@@ -179,6 +180,33 @@ module Metro
     alias_method :button_hold, :on_hold
     alias_method :button_held, :on_hold
 
+
+    #
+    # Register for mouse movements events. These events are fired each update
+    # providing an event which contains the current position of the mouse.
+    #
+    # @note mouse movement events fire with each update so it is up to the
+    #    receiving object of the event to determine if the new mouse movement
+    #    is a delta.
+    #
+    # @note mouse movement events require that the window be specified during initialization.
+    #
+    # @example Registering for button held events
+    #
+    #     class ExampleScene
+    #
+    #       draws :player
+    #
+    #       event :on_mouse_movement do |event|
+    #         player.position = event.mouse_point
+    #       end
+    #     end
+    #
+    def on_mouse_movement(*args,&block)
+      options = (args.last.is_a?(Hash) ? args.pop : {})
+      @mouse_movement_actions << ( block || lambda { |instance| send(options[:do]) } )
+    end
+
     #
     # Register for a custom notification event. These events are fired when
     # another object within the game posts a notification with matching criteria.
@@ -217,7 +245,11 @@ module Metro
       custom_notifications[param.to_sym] = custom_notifications[param.to_sym] + [ block ]
     end
 
-    attr_reader :up_actions, :down_actions, :held_actions, :custom_notifications
+    attr_reader :up_actions, :down_actions, :held_actions
+
+    attr_reader :mouse_movement_actions
+
+    attr_reader :custom_notifications
 
     def _on(hash,args,block)
       options = (args.last.is_a?(Hash) ? args.pop : {})
@@ -254,6 +286,16 @@ module Metro
       end
     end
 
+    #
+    # Fire events for all the registered actions that are suppose to receive
+    # the mouse movement events.
+    #
+    def fire_events_for_mouse_movement
+      mouse_movement_actions.each do |action|
+        execute_block_for_target(&action)
+      end
+    end
+
     def execute_block_for_target(&block)
       event_data = EventData.new(window)
       target.instance_exec(event_data,&block)

data/lib/metro/events/event_state_manager.rb

@@ -25,6 +25,13 @@ module Metro
       current_state.each {|cs| cs.fire_events_for_held_buttons }
     end
 
+    #
+    # Fire events for mouse events within the current game state
+    #
+    def fire_events_for_mouse_movement
+      current_state.each {|cs| cs.fire_events_for_mouse_movement }
+    end
+
     #
     # Fire events for button up for the current game state
     #

data/lib/metro/image.rb

@@ -32,6 +32,12 @@ module Metro
     #       path: "asset_path", tileable: tileable
     #
     def self.find_or_create(options)
+      begin
+        File.open(File.join("assets", options[:path]), "r")
+      rescue Exception
+        puts $! # <- make this prettier
+        options[:path] = "missing.png" # <- make this file installed by default into the assets folder of the game
+      end
       path = AssetPath.with(options[:path])
       images[path.to_s] or (images[path.to_s] = create(options))
     end
@@ -50,6 +56,13 @@ module Metro
       new gosu_image, asset_path.path, tileable
     end
 
+    def self.crop(window,image,bounds)
+      cropped_image = TexPlay.create_image(window,bounds.width,bounds.height)
+      cropped_image.refresh_cache
+      cropped_image.splice image, 0, 0, crop: [ bounds.left, bounds.top, bounds.right, bounds.bottom ]
+      cropped_image
+    end
+
     private
 
     def self.create_params(options)

data/lib/metro/models/model.rb

@@ -49,13 +49,13 @@ module Metro
 
     #
     # This is called after an update. A model normally is not removed after
-    # an update, however if the model responds true to #completed? then it
+    # an update, however if the model responds true to #update_completed? then it
     # will be removed.
     #
     # @note This method should be implemented in the Model sublclass if you
     #   are interested in having the model be removed from the scene.
     #
-    def completed? ; false ; end
+    def update_completed? ; false ; end
 
     #
     # This is called after every {#update} and when the OS wants the window to
@@ -65,6 +65,16 @@ module Metro
     #
     def draw ; end
 
+    #
+    # This is called after a draw. A model normally is not removed after
+    # a draw, however if the model responds true to #draw_completed? then it
+    # will be removed.
+    #
+    # @note This method should be implemented in the Model sublclass if you
+    #   are interested in having the model be removed from the scene.
+    #
+    def draw_completed? ; false ; end
+
     def self.model_name(model_name=nil)
       @model_name ||= to_s.underscore
       model_name ? @model_name = model_name.to_s : @model_name

data/lib/metro/models/properties/options_property/options.rb

@@ -40,7 +40,11 @@ module Metro
         # count of options will reset to the beginning of the list of options.
         # Values that proceed the start of of the list of options will fallback to the last option.
         #
+        # @param [Fixnum,Object] value is the integer position within the menu
+        #   to select or the item in the options to select.
+        #
         def current_selected_index=(value)
+          value = index(value) unless value.is_a?(Fixnum)
           @current_selected_index = value || 0
           @current_selected_index = 0 if @current_selected_index >= count
           @current_selected_index = count - 1 if @current_selected_index <= -1

data/lib/metro/models/ui/physics_sprite.rb

@@ -0,0 +1,105 @@
+module Metro
+  module UI
+
+    #
+    # A physics sprite is a Metro model that is specially designed to draw and
+    # manage an image. A sprite maintains an image, location information, and
+    # rotation. It also has a physics body and shape to assist with being
+    # placed within a `Metro::UI::Space`.
+    #
+    class PhysicsSprite < Sprite
+
+      # @attribute
+      # The mass specified here is given to the body.
+      property :mass, default: 10
+
+      # @attribute
+      # The moment of inertia determines how the sprite will react to the forces
+      # applied to it.
+      property :moment_of_interia, default: 1000000
+
+      # @attribute
+      # A physics sprite has by default a collision shape that is a square.
+      # So this property defines the length of one side which is used to create
+      # the appropriately sized shape for the sprite.
+      property :shape_size, default: 48.0
+
+      # @attribute
+      # The name of the shape. This name is important when the space defines
+      # actions based on the collision of particular objects. By default all
+      # physics sprites are named 'object'.
+      property :shape_name, type: :text, default: "object"
+
+      # @attribute
+      # When this value is true the bounding box will be placed around the
+      # sprite. This is useful in determining correct sizes and collisions.
+      property :debug, type: :boolean, default: false
+
+      # @return the body of the physics sprite that is created with the mass
+      #   and moment of interia specified in the other properties.
+      def body
+        @body ||= begin
+          body = CP::Body.new(mass,moment_of_interia)
+          body.p = CP::Vec2::ZERO
+          body.v = CP::Vec2::ZERO
+          body.a = 0
+          body
+        end
+      end
+
+      # @return a polygon shape for the physics sprite with the size based on
+      #   the `shape_size` property value.
+      def shape
+        @shape ||= begin
+          poly_array = [ [ -1 * shape_size, -1 * shape_size ],
+            [ -1 * shape_size, shape_size ],
+            [ shape_size, shape_size ],
+            [ shape_size, -1 * shape_size ] ].map do |x,y|
+              CP::Vec2.new(x,y)
+          end
+
+          new_shape = CP::Shape::Poly.new(body,poly_array, CP::Vec2::ZERO)
+          new_shape.collision_type = shape_name.to_sym
+          new_shape.e = 0.0
+          new_shape
+
+        end
+      end
+
+      # An helper method that makes it easy to apply an impulse to the body at
+      # the center of the body. The impulse provided is in two parameters, the
+      # x and y component.
+      def push(x_amount,y_amount)
+        body.apply_impulse(CP::Vec2.new(x_amount,y_amount),CP::Vec2.new(0.0, 0.0))
+      end
+
+      # Upon the scene start the body is assigned the x and y position. If this
+      # method is overriden the position will need to be set manually.
+      def show
+        body.p = CP::Vec2.new(x,y)
+      end
+
+      # On update track the position of the sprite based on the position of the
+      # physics body.
+      def update
+        self.x = body.p.x
+        self.y = body.p.y
+      end
+
+      # On draw, draw the specified sprite.
+      def draw
+        angle_in_degrees = body.a.radians.to_degrees
+        image.draw_rot(x,y,z_order,angle_in_degrees)
+
+        draw_bounding_box if debug
+      end
+
+      def draw_bounding_box
+        @bounding_box_border ||= create "metro::ui::border"
+        @bounding_box_border.position = Point.at(position.x - shape_size,shape.bb.t)
+        @bounding_box_border.dimensions = Dimensions.of(shape.bb.r - shape.bb.l,shape.bb.b - shape.bb.t)
+        @bounding_box_border.draw
+      end
+    end
+  end
+end