gamebox 0.4.0.rc1 → 0.4.0.rc2

data/TODO.txt

@@ -1,4 +1,6 @@
 TAKE YOUR PICK:
+ - add define_style that defines a bucket of behaviors
+ - add helper for has_required_attributes on an actor from a behavior (checking that opts for the behavior has said key)
  - move all classes into Gamebox module
  - collision detection performance for tiles?
  - collision detection honoring rotation?

data/docs/getting_started.rdoc

@@ -6,7 +6,7 @@ Why use Gamebox? Gamebox was designed to spring board game development. It allow
 
 The driving idea behind Gamebox is to provide the ability to have as many of the basic common pieces of a 2D game at the developers disposal from the beginning.  
 
-The reason I wrote Gamebox is twofold: first, to aid in 48 hour game writing competitions and second, to allow me to write simple educational games for my kid(s).
+The reason I wrote Gamebox is twofold: first, to aid in 48 hour game writing competitions and second, to allow me to write simple educational games for my kids.
 
 == Installation
 
@@ -14,6 +14,7 @@ The reason I wrote Gamebox is twofold: first, to aid in 48 hour game writing com
 - or tar from http://shawn42.github.com/gamebox
 - or git pull from git://github.com/shawn42/gamebox.git
 - required gems
+  - rake
   - bundler
   - gosu 
   - conject
@@ -25,58 +26,50 @@ The reason I wrote Gamebox is twofold: first, to aid in 48 hour game writing com
 - gamebox zapper
 - this will create the directory structure and needed files to get a basic actor up on the screen
 	zapper
-	|-- README
-	|-- Rakefile
-	|-- config
-	|   |-- boot.rb
-	|   |-- environment.rb
-	|   |-- game.yml
-	|   |-- gamebox_generator_version.yml
-	|   `-- stage_config.yml
-	|-- data
-	|   |-- fonts
-	|   |   `-- FONTS_GO_HERE
-	|   |-- graphics
-	|   |   `-- GRAPHICS_GO_HERE
-	|   |-- music
-	|   |   `-- MUSIC_GOES_HERE
-	|   `-- sounds
-	|       `-- SOUND_FX_GO_HERE
-	|-- doc
-	|   `-- README_FOR_APP
-	|-- lib
-	|   |-- code_statistics.rb
-	|   `-- platform.rb
-  |-- script
-  |   `-- generate
-  |-- spec
-  |   `-- helper.rb
-	`-- src
-	    |-- app.rb
-	    |-- demo_stage.rb
-	    |-- game.rb
-	    `-- my_actor.rb
+    ├── Gemfile
+    ├── README.rdoc
+    ├── Rakefile
+    ├── config
+    │   ├── boot.rb
+    │   ├── environment.rb
+    │   └── game.yml
+    ├── data
+    │   ├── fonts
+    │   │   └── FONTS_GO_HERE
+    │   ├── graphics
+    │   │   └── GRAPHICS_GO_HERE
+    │   ├── music
+    │   │   └── MUSIC_GOES_HERE
+    │   └── sounds
+    │       └── SOUND_FX_GO_HERE
+    ├── spec
+    │   └── helper.rb
+    └── src
+        ├── actors
+        │   └── player.rb
+        ├── app.rb
+        └── demo_stage.rb
 
 - you now have a runnable gamebox game
 
 	cd zapper
-	ruby src/app.rb
+	rake
 
 == Actors to the Stage
 
-An Actor is the base class for any game object. A building, the player, the score, the bullet are all examples of actors. Actors can even be invisible. Any number of Behavior s can be added to an Actor to define how it will react to the world via the Actor.has_behaviors method.
+An actor is the base class for any game object. A building, the player, the score, the bullet are all examples of actors. Actors can even be invisible. Any number of behaviors can be added to an actor to define how it will react to the world via the define_actor method. Actors are simply buckets of data and behaviors. The interactions with system are all driven by their behaviors.
 
-So Actors sound fun, how do I get one? That's where the ActorFactory comes in. In your Stage class (demo_stage.rb by default) you can use the spawn helper method as shown below.
+So Actors sound fun, how do I get one? That's where the ActorFactory comes in. In your Stage class (demo_stage.rb by default) you can use the create_actor helper method as shown below.
 
-	@score = spawn :score, :x => 10, :y => 10
+	@score = create_actor :score, x: 10, y: 10
 	
-This call will return an instance of the Score class (the first arg is the symbolized version of the classname).  It will also create the view for the actor and register it to be drawn.  Which view is instantiated depends on the actor requested.  The factory will always look for a class named the same as the actor with View on the end. So the actor Score will look for ScoreView.  If ScoreView does not exist, a generic view class will be used based on the behaviors of the actor. Each ActorView class is constructed with a reference to the actor it is displaying. See ActorFactor#build for more details.
+This call will return an instance of a score (the first arg is the symbolized version of the actor type).  It will also create the view for the actor and register it to be drawn.  Which view is instantiated depends on the actor requested.  The factory will always look for a view named the same as the actor with _view on the end. So the actor score will look for score_view.  If score_view does not exist, a generic view class will be used based on the behaviors of the actor. Each view is constructed with a reference to the actor it is displaying. See ActorFactor#build for more details.
 
-That's great, but how do I tell my actors what to do?  They can register for events of course! A common place for this is in your actor's setup method. Here is an example from the roids example.
+That's great, but how do I tell my actors what to do? By defining their behaviors!
 
-	input_manager.reg KeyDownEvent, K_SPACE do
-		shoot
-	end
+define_actor :score do
+  has_behaviors :positioned, :score_keeping
+end
 
 == Sound
 
@@ -92,7 +85,7 @@ or
 
 	# from an actor
   has_behavior :audible
-	play_sound :jump
+	actor.react_to :play_sound, :jump
 
 == Resources
 
@@ -103,10 +96,23 @@ All file loading is handled by the ResourceManager.  It handles loading images,
 == Behaviors
 
 Behaviors are designed to allow you to build Actors from previously built chunks of code. Lets look at the built in Animated behavior.
-  class SuperHero < Actor
-    has_behaviors :animated, :updatable
+  define_behavior :shooting do
+    requires :input_manager
+    setup do
+      input_manager.reg :down, KbSpace do
+        shoot
+      end
+    end
+
+    helpers do
+      def shoot
+        # shoot
+      end
+    end
   end
 
+
+
 This snippet show us that our Actor wants to be updated on every gameloop and that it wants to be animated.  Gamebox favors convention over configuration. This means that there are default locations and setting for most things. They can be overridden but you are not required to do so. The animated behavior assumes that your animated images are in a directory structure based on the Actor's underscored name and its current action.
 
 	zapper/

data/lib/gamebox/actors/label.rb

@@ -17,6 +17,7 @@ Behavior.define :label_stuff do
     actor.has_attributes font_style: font_style
 
     actor.when :font_size_changed do
+      actor.font_style.size = actor.font_size
       actor.font_style.reload
       recalculate_size
     end
@@ -27,6 +28,9 @@ Behavior.define :label_stuff do
     actor.when :text_changed do
       recalculate_size
     end
+    actor.when :color_changed do
+      actor.font_style.color = actor.color
+    end
 
   end
 
@@ -39,7 +43,7 @@ Behavior.define :label_stuff do
 end
 
 Actor.define :label do
-  has_behavior layered: 1
+  has_attributes layered: 1
   has_behavior :label_stuff
 
   view do

data/lib/gamebox/behaviors/collidable.rb

@@ -52,14 +52,14 @@ Behavior.define :collidable do
 
     stage.register_collidable actor
 
-    reacts_with :remove, :position_changed
-  end
-
-  helpers do
-    def remove
+    actor.when :remove_me do
       stage.unregister_collidable actor
     end
 
+    reacts_with :position_changed
+  end
+
+  helpers do
     def position_changed
       shape = actor.shape
       shape.recalculate_collidable_cache

data/lib/gamebox/behaviors/graphical.rb

@@ -4,6 +4,7 @@
 # data/graphics/classname.png
 Behavior.define :graphical do
 
+  requires_behaviors :layered
   requires :resource_manager
   setup do 
     image = resource_manager.load_actor_image(actor)

data/lib/gamebox/core/aabb_tree.rb

@@ -38,8 +38,10 @@ class AABBTree
 
   def remove(item)
     leaf = @items.delete item
-    @root = @root.remove_subtree leaf if leaf
-    clear_cached_collisions leaf
+    if leaf
+      @root = @root.remove_subtree leaf 
+      clear_cached_collisions leaf
+    end
   end
 
   def update(item)

data/lib/gamebox/core/actor.rb

@@ -9,9 +9,8 @@ class Actor
   construct_with :this_object_context
   public :this_object_context
 
-  has_attribute :alive
-
   def initialize
+    has_attribute :alive
     @behaviors = {}
   end
 
@@ -58,7 +57,6 @@ class Actor
   end
 
   # TODO should this live somewhere else?
-  # TODO should we support "inheritance" of components?
   class << self
 
     def define(actor_type, opts={}, &blk)
@@ -71,6 +69,12 @@ class Actor
       if view_blk
         ActorView.define "#{actor_type}_view".to_sym, &view_blk
       end
+
+      behavior_blk = definition.behavior_blk
+      if behavior_blk
+        Behavior.define actor_type, &behavior_blk
+        definition.has_behavior actor_type
+      end
     end
 
     def definitions
@@ -80,7 +84,7 @@ class Actor
   end
 
   class ActorDefinition
-    attr_accessor :behaviors, :attributes, :view_blk
+    attr_accessor :behaviors, :attributes, :view_blk, :behavior_blk
     def initialize
       @behaviors = []
       @attributes = []
@@ -93,10 +97,20 @@ class Actor
     end
     alias has_behavior has_behaviors
 
-    # TODO spec view helper on actor def
+    def has_attributes(*attributes)
+      attributes.each do |att|
+        @attributes << att
+      end
+    end
+    alias has_behavior has_behaviors
+
     def view(&blk)
       @view_blk = blk
     end
+
+    def behavior(&blk)
+      @behavior_blk = blk
+    end
   end
 
 end

data/lib/gamebox/core/actor_factory.rb

@@ -18,6 +18,10 @@ class ActorFactory
         raise "#{actor} not found in Actor.definitions" if actor_definition.nil?
         model.configure(merged_opts)
 
+        actor_definition.attributes.each do |attr|
+          model.has_attributes attr
+        end
+
         actor_definition.behaviors.each do |behavior|
           beh_opts = {}
           beh_key = behavior

data/lib/gamebox/core/actor_view_factory.rb

@@ -8,6 +8,7 @@ class ActorViewFactory
   def build(actor, opts={})
     # TODO  have animated, graphical, physical set a view attr on actor
     view_klass = opts[:view] || actor.do_or_do_not(:view) || "#{actor.actor_type}_view"
+
     view_definition = ActorView.definitions[view_klass.to_sym]
     view = nil
     if view_definition

data/lib/gamebox/core/director.rb

@@ -4,51 +4,19 @@ class Director
   can_fire_anything
   attr_accessor :actors
 
-  def initialize
-    @actors = []
-    @dead_actors = []
-    setup
-  end
-
-  def setup
-  end
-
-  def add_actor(actor)
-    @actors << actor
-    actor.when :remove_me do
-      remove_actor actor
-    end
-    fire :actor_added, actor
-    actor
-  end
-
-  def remove_actor(actor)
-    @dead_actors << actor
-  end
-
-  def empty?
-    @actors.empty?
-  end
-
   def pause
-    @paused_actors = @actors
-    @actors = []
+    @paused_subscriptions = @subscriptions
+    @subscriptions = {}
   end
 
   def unpause
-    unless @paused_actors.nil?
-      @actors.each{|actor| actor.remove_self }
-      @actors = @paused_actors
-      @paused_actors = nil
+    unless @paused_subscriptions.nil?
+      @subscriptions = @paused_subscriptions
+      @paused_subscriptions = nil
     end
   end
 
   def update(time)
-    for act in @dead_actors
-      @actors.delete act
-      fire :actor_removed, act
-    end
-    @dead_actors = []
     time_in_seconds = time / 1000.to_f
     fire :update, time, time_in_seconds
   end

data/lib/gamebox/core/resource_manager.rb

@@ -41,8 +41,7 @@ class ResourceManager
   #       -------------
   #
   def load_tile_set(actor, action)
-    actor_dir = Inflector.underscore(actor.class)
-    tileset_name = "#{actor_dir}/#{action}.png"
+    tileset_name = "#{actor.actor_type}/#{action}.png"
     tileset = load_image tileset_name
 
     action_imgs = []

data/lib/gamebox/core/sound_manager.rb

@@ -78,6 +78,14 @@ class SoundManager
       @music[what].stop if @music[what]
     end
   end
+
+  # pause the music file that is passed in.
+  # pause_music :foo
+  def pause_music(what)
+    if @enabled
+      @music[what].pause if @music[what]
+    end
+  end
   
   # stops the sound that is passed in.
   # stop_sound :foo

data/lib/gamebox/version.rb

@@ -3,7 +3,7 @@ module Gamebox
     MAJOR = 0
     MINOR = 4
     TINY  = 0
-    RC    = 1
+    RC    = 2
 
     if RC > 0
       ARRAY = [MAJOR, MINOR, TINY, "rc#{RC}"]

data/spec/acceptance/basic_actor_lifecycle_spec.rb

@@ -88,5 +88,7 @@ describe "The basic life cycle of an actor", acceptance: true do
     game.should_not have_actor(:mc_bane)
 
   end
+
+  it 'uses default values from actor definition'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gamebox
 version: !ruby/object:Gem::Version
-  version: 0.4.0.rc1
+  version: 0.4.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu