chingu 0.8.0.4 → 0.8.0.5

data/chingu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.8.0.4"
+  s.version = "0.8.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
-  s.date = %q{2011-01-02}
+  s.date = %q{2011-01-03}
   s.description = %q{OpenGL accelerated 2D game framework for Ruby. Builds on Gosu (Ruby/C++) which provides all the core functionality. Chingu adds simple yet powerful game states, prettier input handling, deployment safe asset-handling, a basic re-usable game object and stackable game logic.}
   s.email = %q{ippa@rubylicio.us}
   s.extra_rdoc_files = [
@@ -54,6 +54,7 @@ Gem::Specification.new do |s|
     "examples/example25.yml",
     "examples/example25_fibers_state_machine.rb",
     "examples/example26_splash_screen.rb",
+    "examples/example27_console.rb",
     "examples/example2_gamestate_basics.rb",
     "examples/example3_parallax.rb",
     "examples/example4_gamestates.rb",
@@ -114,6 +115,7 @@ Gem::Specification.new do |s|
     "lib/chingu/assets.rb",
     "lib/chingu/basic_game_object.rb",
     "lib/chingu/classic_game_object.rb",
+    "lib/chingu/console.rb",
     "lib/chingu/core_ext/array.rb",
     "lib/chingu/fpscounter.rb",
     "lib/chingu/game_object.rb",
@@ -162,6 +164,7 @@ Gem::Specification.new do |s|
     "spec/chingu/animation_spec.rb",
     "spec/chingu/assets_spec.rb",
     "spec/chingu/basic_game_object_spec.rb",
+    "spec/chingu/console_spec.rb",
     "spec/chingu/fpscounter_spec.rb",
     "spec/chingu/game_object_list_spec.rb",
     "spec/chingu/game_object_spec.rb",
@@ -203,6 +206,7 @@ Gem::Specification.new do |s|
     "examples/example24_enter_name.rb",
     "examples/example25_fibers_state_machine.rb",
     "examples/example26_splash_screen.rb",
+    "examples/example27_console.rb",
     "examples/example2_gamestate_basics.rb",
     "examples/example3_parallax.rb",
     "examples/example4_gamestates.rb",
@@ -217,6 +221,7 @@ Gem::Specification.new do |s|
     "spec/chingu/animation_spec.rb",
     "spec/chingu/assets_spec.rb",
     "spec/chingu/basic_game_object_spec.rb",
+    "spec/chingu/console_spec.rb",
     "spec/chingu/fpscounter_spec.rb",
     "spec/chingu/game_object_list_spec.rb",
     "spec/chingu/game_object_spec.rb",

data/examples/example24_enter_name.rb

@@ -9,10 +9,12 @@ class Game < Chingu::Window
     super(800,400,false)              # leave it blank and it will be 800,600,non fullscreen
     self.input = { :escape => :exit } # exits example on Escape    
     self.caption = "Demonstration of GameStates::EnterName"
-    push_game_state(GameStates::EnterName.new(:callback => :got_name))
+    push_game_state(GameStates::EnterName.new(:callback => method(:got_name)))
   end
   
-  def got_name
+  def got_name(name)
+    puts "Got name: #{name}"
+    exit
   end
 end
 

data/examples/example27_console.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require File.join(File.dirname($0), "..", "lib", "chingu")
+include Gosu
+include Chingu
+
+#
+# Chingu::Console tries to emulate how Chingu::Window works but without GFX and keyboardinput
+#
+class Game < Chingu::Console
+  
+  def update
+    super
+    sleep(0.02) # fake some cpu intensive game logic :P
+    puts "Gameloop running at #{fps} FPS. milliseconds since last tick #{dt}."
+  end
+  
+end
+
+Game.new.show

data/lib/chingu.rb

@@ -37,7 +37,7 @@ require_all "#{CHINGU_ROOT}/chingu/traits"
 require_all "#{CHINGU_ROOT}/chingu"
 
 module Chingu
-  VERSION = "0.8.0.4"
+  VERSION = "0.8.0.5"
   
   DEBUG_COLOR = Gosu::Color.new(0xFFFF0000)
   DEBUG_ZORDER = 9999

data/lib/chingu/console.rb

@@ -0,0 +1,134 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
+module Chingu
+  #
+  #  Console is the non-gfx variant of
+  #
+  #
+  class Console
+    include Chingu::Helpers::GameState          # Easy access to the global game state-queue
+    include Chingu::Helpers::GameObject         # Adds game_objects_of_class etc ...
+    
+    attr_reader :root, :game_state_manager, :game_objects, :milliseconds_since_last_tick, :factor
+    
+    def initialize(update_interval = 16.666666)			
+      $window = self
+      @update_interval = update_interval
+      @root = File.dirname(File.expand_path($0))
+      @game_objects = GameObjectList.new      
+      @fps_counter = FPSCounter.new
+      @game_state_manager = GameStateManager.new
+      @milliseconds_since_last_tick = 0
+      @factor = 1
+      setup
+    end
+            
+    #
+    # This is our "game-loop". Will loop forever, with framerate specified and call update()
+    # The idea is to be very simular to how a Chingu::Window works.
+    #
+    def start
+      loop do
+        t1 = Time.now
+        update
+        t2 = Time.now
+        update_duration = t2 - t1
+        
+        milliseconds = (@update_interval/1000 - update_duration)
+        sleep(milliseconds)  if milliseconds > 0
+      end
+    end
+    alias :show :start
+
+    # Placeholder to be overwritten
+    def setup; end;
+    
+    #
+    # Returns self inside GameState.initialize (a game state is not 'active' inside initialize())
+    # Or returns current active game state (as in a switched to or pushed game state)
+    # ... Falls back to returning $window
+    #
+    # current_scope is used to make GameObject.all and friends work everywhere.
+    #
+    def current_scope
+      game_state_manager.inside_state || game_state_manager.current_game_state || self
+    end
+    
+    #
+    # Frames per second, access with $window.fps or $window.framerate
+    #
+    def fps
+      @fps_counter.fps
+    end
+    alias :framerate :fps
+
+    #
+    # Total amount of game iterations (ticks)
+    #
+    def ticks
+      @fps_counter.ticks
+    end
+    
+    #
+    # Mathematical short name for "milliseconds since last tick"
+    #
+    def dt
+      @milliseconds_since_last_tick
+    end
+
+    #
+    # Chingus core-logic / loop. Gosu will call this each game-iteration.
+    #
+    def update
+      #
+      # Register a tick with our rather standard tick/framerate counter. 
+      # Returns the amount of milliseconds since last tick. This number is used in all update()-calls.
+      # Without this self.fps would return an incorrect value.
+      # If you override this in your Chingu::Window class, make sure to call super.
+      #
+      @milliseconds_since_last_tick = @fps_counter.register_tick
+      
+      intermediate_update
+    end
+    
+    #
+    # "game logic" update that is safe to call even between Gosus update-calls
+    #
+    def intermediate_update
+      #
+      # Call update() on all game objects belonging to the main window.
+      #
+      @game_objects.update
+      
+      #
+      # Call update() on all game objects belonging to the current game state.
+      #
+
+      #
+      # Call update() on our game_state_manger
+      # -> call update on active states
+      # -> call update on all game objects in that state
+      #
+      @game_state_manager.update
+    end
+  end
+end

data/spec/chingu/console_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module Chingu
+
+  describe "Console" do
+    before :each do
+      @console = Chingu::Console.new
+    end
+    
+    it { @console.should respond_to :start }
+    it { @console.should respond_to :fps }
+    it { @console.should respond_to :update }
+    it { @console.should respond_to :root }
+    it { @console.should respond_to :game_state_manager }
+    it { @console.should respond_to :root }
+    it { @console.should respond_to :milliseconds_since_last_tick }
+        
+    context "a new Chingu::Console" do
+      
+      it "should return itself as current scope" do
+        @console.current_scope.should == @console
+      end
+      
+      it "should have 0 game objects" do
+        @console.game_objects.size.should == 0
+      end
+    end
+    
+    context "each game iteration" do
+      
+      it "@console.update() should call update() on all unpaused game objects" do
+        GameObject.create.should_receive(:update)
+        GameObject.create(:paused => true).should_not_receive(:update)
+        @console.update
+      end
+
+      it "should increment $window.ticks" do
+        @console.ticks.should == 0
+        @console.update
+        @console.ticks.should == 1
+        @console.update
+        @console.ticks.should == 2
+      end
+      
+    end
+  end
+end

data/spec/chingu/window_spec.rb

@@ -50,6 +50,12 @@ module Chingu
         @game.game_objects.first.visible?.should == false
         @game.draw
       end
+      
+      it "should increment $window.ticks" do
+        @game.ticks.should == 0
+        @game.update
+        @game.ticks.should == 1
+      end
     end
   end
 end

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 8
   - 0
-  - 4
-  version: 0.8.0.4
+  - 5
+  version: 0.8.0.5
 platform: ruby
 authors: 
 - ippa
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-02 00:00:00 +01:00
+date: 2011-01-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -147,6 +147,7 @@ files:
 - examples/example25.yml
 - examples/example25_fibers_state_machine.rb
 - examples/example26_splash_screen.rb
+- examples/example27_console.rb
 - examples/example2_gamestate_basics.rb
 - examples/example3_parallax.rb
 - examples/example4_gamestates.rb
@@ -207,6 +208,7 @@ files:
 - lib/chingu/assets.rb
 - lib/chingu/basic_game_object.rb
 - lib/chingu/classic_game_object.rb
+- lib/chingu/console.rb
 - lib/chingu/core_ext/array.rb
 - lib/chingu/fpscounter.rb
 - lib/chingu/game_object.rb
@@ -255,6 +257,7 @@ files:
 - spec/chingu/animation_spec.rb
 - spec/chingu/assets_spec.rb
 - spec/chingu/basic_game_object_spec.rb
+- spec/chingu/console_spec.rb
 - spec/chingu/fpscounter_spec.rb
 - spec/chingu/game_object_list_spec.rb
 - spec/chingu/game_object_spec.rb
@@ -322,6 +325,7 @@ test_files:
 - examples/example24_enter_name.rb
 - examples/example25_fibers_state_machine.rb
 - examples/example26_splash_screen.rb
+- examples/example27_console.rb
 - examples/example2_gamestate_basics.rb
 - examples/example3_parallax.rb
 - examples/example4_gamestates.rb
@@ -336,6 +340,7 @@ test_files:
 - spec/chingu/animation_spec.rb
 - spec/chingu/assets_spec.rb
 - spec/chingu/basic_game_object_spec.rb
+- spec/chingu/console_spec.rb
 - spec/chingu/fpscounter_spec.rb
 - spec/chingu/game_object_list_spec.rb
 - spec/chingu/game_object_spec.rb