ippa-chingu 0.4.0 → 0.4.1

data/chingu.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
-  s.date = %q{2009-08-19}
+  s.date = %q{2009-08-20}
   s.description = %q{Game framework built on top of the OpenGL accelerated game lib Gosu.  It adds simple yet powerfull game states, prettier inputhandling, deploymentsafe asset-handling, a basic re-usable game object and automation of common task.}
   s.email = ["ippa@rubylicio.us"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt"]

data/examples/example1.rb

@@ -1,12 +1,12 @@
 require 'rubygems'
-require '../lib/chingu.rb'
+require File.join(File.dirname($0), "..", "lib", "chingu")
 include Gosu
 
 #
 # A minimalistic Chingu example.
 # Chingu::Window provides #update and #draw which calls corresponding methods for all objects based on Chingu::Actors
 #
-# Image["picture.png"] is a deploymentsafe shortcut to Gosu's Image.new and supports multiple locations for "picture.png"
+# Image["picture.png"] is a deployment safe shortcut to Gosu's Image.new and supports multiple locations for "picture.png"
 # By default current dir, media\ and gfx\ is searched. To add own directories:
 #
 # Image.autoload_dirs << File.join(self.root, "data", "my_image_dir")  
@@ -16,7 +16,7 @@ class Game < Chingu::Window
     super 
     @player = Player.new(:x => 200, :y => 200, :image => Image["spaceship.png"])
     @player.input = { :holding_left => :move_left, :holding_right => :move_right, 
-                      :holding_up => :move_up, :holding_down => :move_down}
+                      :holding_up => :move_up, :holding_down => :move_down, :escape => :exit}
   end
   
   def update

data/examples/example2.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require '../lib/chingu.rb'
+require File.join(File.dirname($0), "..", "lib", "chingu")
 include Gosu
 
 #
@@ -19,7 +19,9 @@ class Game < Chingu::Window
                       :holding_right => :move_right, 
                       :holding_up => :move_up, 
                       :holding_down => :move_down, 
-                      :space => :fire}
+                      :space => :fire,
+                      :escape => :exit
+                      }
   end
 
   #

data/examples/example3.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require '../lib/chingu.rb'
+require File.join(File.dirname($0), "..", "lib", "chingu")
 include Gosu
 
 #
@@ -9,7 +9,7 @@ include Gosu
 class Game < Chingu::Window
   def initialize
     super    
-    self.input = {:holding_left => :scroll_left, :holding_right => :scroll_right, :escape => :close}
+    self.input = {:holding_left => :scroll_left, :holding_right => :scroll_right, :escape => :exit}
     
     @parallax = Chingu::Parallax.new(:x => 0, :y => 0, :center_x => 0, :center_y => 0)
     

data/examples/example4.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require '../lib/chingu.rb'
+require File.join(File.dirname($0), "..", "lib", "chingu")
 include Gosu
 
 #
@@ -34,7 +34,7 @@ class Game < Chingu::Window
     push_game_state(Intro)
     
     # Yes you can do crazy things like this :)
-    self.input = { :left_mouse_button => lambda{Chingu::Text.new(:text => "Woff!")}, :esc => :close}    
+    self.input = { :left_mouse_button => lambda{Chingu::Text.new(:text => "Woff!")}, :esc => :exit}    
   end
 end
 

data/lib/chingu/game_state.rb

@@ -75,7 +75,7 @@ module Chingu
     #
     def button_down(id)
       dispatch_button_down(id, self)
-      @input_clients.each { |object| dispatch_button_down(id, object) }
+      @input_clients.each { |object| dispatch_button_down(id, object) } if @input_clients
     end
     
     #
@@ -83,7 +83,7 @@ module Chingu
     #
     def button_up(id)
       dispatch_button_up(id, self)
-      @input_clients.each { |object| dispatch_button_up(id, object) }
+      @input_clients.each { |object| dispatch_button_up(id, object) }   if @input_clients
     end
     
     #

data/lib/chingu/game_state_manager.rb

@@ -2,10 +2,22 @@ module Chingu
   #
   # GameStateManger is responsible for keeping track of game states with a simple pop/push stack.
   #
-  # Related blogpost: http://gamedevgeek.com/tutorials/managing-game-states-in-c/
+  # More about the concept of states in games:
+  # http://gamedevgeek.com/tutorials/managing-game-states-in-c/
+  # http://www.gamedev.net/community/forums/topic.asp?topic_id=477320
   #
   # Chingu::Window automatically creates a @game_state_manager and makes it accessible in our game loop.
-  # By default the game loop calls update() / draw() on @game_state_manager
+  # By default the game loop calls update(dt), draw, button_up(id) and button_down(id) on the active state.
+  #
+  # ==== Chingu Examples
+  #
+  # Enter a new game state, Level, don't call finalize() on the game state we're leaving.
+  #   push_game_state(Level, :finalize => false)
+  #
+  # Return to the previous game state, don't call setup() on it when it becomes active.
+  #   pop_game_state(:setup => false)
+  #
+  # If you want to use Chingus GameStateManager _without_ Chingu::Windoe, see example5.rb
   #
   class GameStateManager
     attr_accessor :inside_state
@@ -14,7 +26,7 @@ module Chingu
       @inside_state = nil
       @game_states = []
     end
-
+    
     #
     # Gets the currently active gamestate (top of stack)
     #
@@ -24,7 +36,7 @@ module Chingu
     alias :current current_game_state
 
     #
-    # Returns all gamestates with top of stack first
+    # Returns all gamestates with currenlty active game state on top.
     #
     def game_states
       @game_states.reverse
@@ -32,6 +44,8 @@ module Chingu
     
     #
     # Switch to a given game state, _replacing_ the current active one.
+    # By default setup() is called on the game state  we're switching _to_.
+    # .. and finalize() is called on the game state we're switching _from_.
     #
     def switch_game_state(state, options = {})
       options = {:setup => true, :finalize => true}.merge(options)
@@ -57,7 +71,9 @@ module Chingu
     alias :switch :switch_game_state
     
     #
-    # Adds a state to the game state-stack and activates it
+    # Adds a state to the game state-stack and activates it.
+    # By default setup() is called on the new game state 
+    # .. and finalize() is called on the game state we're leaving.
     #
     def push_game_state(state, options = {})
       options = {:setup => true, :finalize => true}.merge(options)
@@ -79,6 +95,8 @@ module Chingu
     
     #
     # Pops a state off the game state-stack, activating the previous one.
+    # By default setup() is called on the game state that becomes active.
+    # .. and finalize() is called on the game state we're leaving.
     #
     def pop_game_state(options = {})
       options = {:setup => true, :finalize => true}.merge(options)
@@ -99,28 +117,7 @@ module Chingu
     alias :pop :pop_game_state
 
     #
-    # Returns a GameState-instance from either a class or object
-    #
-    def game_state_instance(state)
-      new_state = nil
-      #
-      # If state is a GameState-instance, just queue it
-      #
-      if state.is_a? Chingu::GameState
-        new_state = state
-      #
-      # If state is a GameState-class, create it.
-      #        
-      elsif state.superclass == Chingu::GameState
-        new_state = state.new({})
-      end
-      
-      return new_state
-    end
-
-
-    #
-    # Returns the previous game state
+    # Returns the previous game state. Shortcut: "previous"
     #
     def previous_game_state
       @game_states[@game_states.index(current_game_state)-1]
@@ -128,7 +125,7 @@ module Chingu
     alias :previous previous_game_state
     
     #
-    # Remove all game states from stack
+    # Remove all game states from stack. Shortcut: "clear"
     #
     def clear_game_states
       @game_states.clear
@@ -143,39 +140,68 @@ module Chingu
         break if state == new_state
       end
     end
-    
-    #
-    # Bellow follows a set of auto-called Gosu::Window methods.
-    # We define them game_state_manager so Gosu::Window can call them here.
-    # Then the game_state_manager is responsible to resend them to the active state. 
-    # Or in the future many states.
+        
     #
-    
+    # This method should be called from button_down(id) inside your main loop.
+    # Enables the game state manager to call button_down(id) on active game state.
     #
-    # Called before #update when the user pressed a button while the window had the focus. 
+    # If you're using Chingu::Window instead of Gosu::Window this will automaticly be called.
     #
     def button_down(id)
       current_game_state.button_down(id) if current_game_state
     end
     
     #
-    # Called when the user released a button. 
+    # This method should be called from button_up(id) inside your main loop.
+    # Enables the game state manager to call button_up(id) on active game state.
+    #
+    # If you're using Chingu::Window instead of Gosu::Window this will automaticly be called.
     #
     def button_up(id)
       current_game_state.button_up(id)  if current_game_state
     end
     
     #
-    # Calls #update on the current gamestate, if there is one.
+    # This method should be called from update() inside your main loop.
+    # Enables the game state manager to call update() on active game state.
+    #
+    # If you're using Chingu::Window instead of Gosu::Window this will automaticly be called.
     #
     def update(time = nil)
       current_game_state.update(time)   if current_game_state
     end
+
+    #
+    # This method should be called from draw() inside your main loop.
+    # Enables the game state manager to call update() on active game state.
     #
-    # Calls draw() on the current gamestate, if there is one.
+    # If you're using Chingu::Window instead of Gosu::Window this will automaticly be called.
     #
     def draw
       current_game_state.draw           if current_game_state
     end
+    
+    private
+    
+    #
+    # Returns a GameState-instance from either a GameState class or GameState-object
+    #
+    def game_state_instance(state)
+      new_state = nil
+      #
+      # If state is a GameState-instance, just queue it
+      #
+      if state.is_a? Chingu::GameState
+        new_state = state
+      #
+      # If state is a GameState-class, create it.
+      #        
+      elsif state.superclass == Chingu::GameState
+        new_state = state.new({})
+      end
+      
+      return new_state
+    end
+    
   end
 end

data/lib/chingu.rb

@@ -26,5 +26,5 @@ require 'set'
     end
 
 module Chingu
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ippa-chingu
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - ippa
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-19 00:00:00 -07:00
+date: 2009-08-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency