gamefic 1.4.1 → 1.5.0

data/lib/gamefic/plot/players.rb

@@ -0,0 +1,15 @@
+module Gamefic
+
+  module Plot::Players
+    def players
+      p_players.clone
+    end
+
+    private
+
+    def p_players
+      @p_players ||= []
+    end
+  end
+
+end

data/lib/gamefic/plot/scene_mount.rb

@@ -1,20 +1,50 @@
-class NotConclusionError < Exception
-end
-
 module Gamefic
 
   module Plot::SceneMount
+    def default_scene
+      @default_scene ||= Scene::Active.new(self)
+    end
+
+    def default_conclusion
+      @default_conclusion ||= Scene::Conclusion.new
+    end
+
+    # Add a block to be executed when a player is added to the game.
+    # Each Plot can only have one introduction. Subsequent calls will
+    # overwrite the existing one.
+    #
+    # @example Welcome the player to the game
+    #   introduction do |actor|
+    #     actor.tell "Welcome to the game!"
+    #   end
+    #
+    # @yieldparam [Character]
+    def introduction (&proc)
+      @introduction = proc
+    end
+
+    # Introduce a player to the game.
+    # This method is typically called by the Engine that manages game execution.
+    def introduce(player)
+      player.playbook = playbook
+      player.cue default_scene
+      p_players.push player
+      @introduction.call(player) unless @introduction.nil?
+    end
+
     # Create a multiple-choice scene.
     # The user will be required to make a valid choice to continue.
     #
     # @yieldparam [Character]
     # @yieldparam [Scene::Data::MultipleChoice]
-    def multiple_choice key, *choices, &block
-      scenes[key] = Scene::MultipleChoice.new
-      scenes[key].on_start do |actor, data|
+    def multiple_choice *choices, &block
+      s = Scene::MultipleChoice.new
+      s.on_start do |actor, data|
+        data.options.clear
         data.options.push *choices
       end
-      scenes[key].on_finish &block
+      s.on_finish &block
+      s
     end
     
     # Create a yes-or-no scene.
@@ -22,22 +52,27 @@ module Gamefic
     #
     # @yieldparam [Character]
     # @yieldparam [String] "yes" or "no"
-    def yes_or_no key, prompt = nil, &block
-      scenes[key] = Scene::YesOrNo.new
+    def yes_or_no prompt = nil, &block
+      s = Scene::YesOrNo.new
       unless prompt.nil?
-        scenes[key].on_start do |actor, data|
+        s.on_start do |actor, data|
           data.prompt = prompt
         end
       end
-      scenes[key].on_finish &block
+      s.on_finish do |actor, data|
+        block.call actor, data unless block.nil?
+        actor.cue default_scene if actor.scene == s and actor.next_scene.nil?
+      end
+      s
     end
     
-    def question key, prompt = 'What is your answer?', &block
-      scenes[key] = Scene::Custom.new
-      scenes[key].on_start do |actor, data|
+    def question prompt = 'What is your answer?', &block
+      s = Scene::Custom.new
+      s.on_start do |actor, data|
         data.prompt = prompt
       end
-      scenes[key].on_finish &block
+      s.on_finish &block
+      s
     end
 
     # Create a scene that pauses the game.
@@ -48,15 +83,17 @@ module Gamefic
     # @param prompt [String] The text to display when prompting the user to continue.
     # @yieldparam [Character]
     # @yieldparam [Scene::Data::Base]
-    def pause key, prompt = nil, &block
-      scenes[key] = Scene::Pause.new
-      scenes[key].on_start do |actor, data|
+    def pause prompt = nil, &block
+      s = Scene::Pause.new
+      s.on_start do |actor, data|
         data.prompt = prompt unless prompt.nil?
         block.call actor, data unless block.nil?
       end
-      scenes[key].on_finish do |actor, data|
-        actor.cue :active if actor.scene == key and actor.next_scene.nil?
+      s.on_finish do |actor, data|
+        #actor.cue :active if actor.scene == key and actor.next_scene.nil?
+        actor.cue default_scene if actor.scene == s and actor.next_scene.nil?
       end
+      s
     end
     
     # Create a conclusion.
@@ -66,9 +103,10 @@ module Gamefic
     # @param key [Symbol] A unique name for the scene.
     # @yieldparam [Character]
     # @yieldparam [Scene::Data::Base]
-    def conclusion key, &block
-      scenes[key] = Scene::Conclusion.new
-      scenes[key].on_start &block
+    def conclusion &block
+      s = Scene::Conclusion.new
+      s.on_start &block
+      s
     end
     
     # Create a custom scene.
@@ -106,10 +144,10 @@ module Gamefic
     # @param key [Symbol] A unique name for the scene.
     # @param key [cls] The class of scene to be instantiated.
     # @yieldparam [Scene::Custom] The instantiated scene.
-    def scene key, cls = Scene::Custom, &block
-      scenes[key] = cls.new
-      #block.call scenes[key]
-      yield scenes[key] if block_given?
+    def scene cls = Scene::Custom, &block
+      s = cls.new
+      yield s if block_given?
+      s
     end
 
     # Choose a new scene based on a list of options.
@@ -130,15 +168,15 @@ module Gamefic
     #
     # @param key [Symbol] A unique name for the scene.
     # @param map [Hash] A Hash of options and associated scene keys.
-    def multiple_scene key, map
-      scenes[key] = Scene::MultipleScene.new
-      scenes[key].on_start do |actor, data|
+    def multiple_scene map
+      s = Scene::MultipleScene.new
+      s.on_start do |actor, data|
         map.each { |k, v|
           data.map k, v
         }
       end
+      s
     end
-
   end
 
 end

data/lib/gamefic/plot/snapshot.rb

@@ -38,10 +38,10 @@ module Gamefic
     # Restore the plot to the state of its first snapshot.
     #
     def restore_initial_state
-        @entities[@initial_state.length..-1].each { |e|
+        p_entities[@initial_state.length..-1].each { |e|
           e.parent = nil
         }
-        @entities.slice! @initial_state.length..-1
+        p_entities.slice! @initial_state.length..-1
         internal_restore @initial_state
     end
     
@@ -86,13 +86,14 @@ module Gamefic
       snapshot.each { |hash|
         if entities[index].nil?
           cls = Kernel.const_get(hash[:class])
-          @entities[index] = make cls
+          p_entities[index] = make cls
         end 
         internal_restore_hash hash, index
         index += 1
       }
       nil
     end
+
     def internal_restore_hash hash, index
       hash.each { |k, v|
         if k == :scene
@@ -108,6 +109,7 @@ module Gamefic
       }
       nil
     end
+
     def reduce entities
       reduced = []
       index = 0
@@ -123,6 +125,7 @@ module Gamefic
       }
       reduced
     end
+
     def can_serialize? obj
       return true if (obj == true or obj == false or obj.nil?)
       allowed = [String, Fixnum, Float, Numeric, Entity, Direction, Hash, Array, Symbol]
@@ -131,6 +134,7 @@ module Gamefic
       }
       false
     end
+
     def serialize_obj obj
       return nil if obj.nil?
       return false if obj == false
@@ -140,13 +144,14 @@ module Gamefic
         return serialize_array obj
       else
         if obj.kind_of?(Entity)
-          return "#<EIN_#{@entities.index(obj)}>"
+          return "#<EIN_#{p_entities.index(obj)}>"
         elsif obj.kind_of?(Direction)
           return "#<DIR_#{obj.name}>"
         end
       end
       return obj
     end
+
     def serialize_hash obj
       hash = {}
       obj.each_pair { |k, v|
@@ -156,6 +161,7 @@ module Gamefic
       }
       return hash
     end
+
     def serialize_array obj
       arr = []
       obj.each_index { |i|
@@ -167,6 +173,7 @@ module Gamefic
       }
       return arr
     end
+
     def unserialize obj
       if obj.kind_of?(Hash)
         unserialize_hash obj
@@ -174,13 +181,14 @@ module Gamefic
         unserialize_array obj
       elsif obj.to_s.match(/^#<EIN_[0-9]+>$/)
         i = obj[6..-2].to_i
-        @entities[i]
+        p_entities[i]
       elsif obj.to_s.match(/^#<DIR_[a-z]+>$/)
         Direction.find(obj[6..-2])
       else
         obj
       end
     end
+
     def unserialize_hash obj
       hash = {}
       obj.each_pair { |k, v|
@@ -188,6 +196,7 @@ module Gamefic
       }
       hash
     end
+
     def unserialize_array obj
       arr = []
       obj.each_index { |i|
@@ -195,7 +204,10 @@ module Gamefic
       }
       arr
     end
+
     def save_subplots
+      # TODO: Subplot snapshots are temporarily disabled.
+      return []
       arr = []
       subplots.each { |s|
         hash = {}
@@ -210,7 +222,10 @@ module Gamefic
       }
       arr
     end
+    
     def restore_subplots arr
+      # TODO: Subplot snapshots are temporarily disabled.
+      return
       players.each { |p|
         p.send(:p_subplots).clear
       }

data/lib/gamefic/scene/active.rb

@@ -5,8 +5,15 @@ module Gamefic
   # a Plot.
   #
   class Scene::Active < Scene::Base
+    attr_reader :plot
+
+    def initialize plot
+      @plot = plot
+    end
+
     def finish actor, input
-      actor.perform input, from_user: true
+      o = actor.perform input.strip
+      actor.performed o
     end
   end
   

data/lib/gamefic/scene/base.rb

@@ -5,43 +5,21 @@ module Gamefic
   #
   class Scene::Base
     def start actor
-      start_data_for actor
     end
 
     def finish actor, input
-      finish_data_for actor, input
     end
     
-    def type
-      self.class.to_s.split('::').last
-    end
-
-    def data_class
-      SceneData::Base
-    end
-
     # Get the prompt to be displayed to the user when accepting input.
     #
     # @return [String] The text to be displayed.
     def prompt_for actor
-      character_data[actor].prompt || '>'
+      '>'
     end
 
-    private
-
-    def character_data
-      @character_data ||= {}
-    end
-
-    def start_data_for actor
-      character_data[actor] = data_class.new
-    end
-
-    def finish_data_for actor, input
-      data = character_data[actor]
-      data.input = input.strip
-      data
+    def type
+      self.class.to_s.split('::').last
     end
   end
-  
+
 end

data/lib/gamefic/scene/custom.rb

@@ -1,32 +1,69 @@
 module Gamefic
   
-  # A Custom Scene is a generic scene that allows for complete configuration
-  # of its behavior upon instantiation. It is suitable for direct instantiation
-  # or extension by other Scene classes.
+  # A Custom Scene allows for complete configuration of its behavior upon
+  # instantiation. It is suitable for direct instantiation or subclassing.
   #
   class Scene::Custom < Scene::Base
     def initialize
       yield self if block_given?
     end
+
+    def data_class
+      SceneData::Base
+    end
+
+    # Define a block to be executed at the start of the scene.
+    # Unlike on_finish, start blocks may be executed more than once per turn,
+    # and more than one scene may be started in a single turn.
+    # It always gets executed in a plot's on_ready event and whenever it gets
+    # cued. (If the character is already in the scene being cued, on_start
+    # does not get repeated.)
+    #
+    # @yieldparam [Character]
+    # @yieldparam [SceneData::Base]
     def on_start &block
       @start = block
     end
 
+    # Define a block to be executed at the end of the scene.
+    # The scene data passed to this block will include the character's input
+    # for this turn.
+    # Unlike on_start, finish only gets executed once per turn, during the
+    # plot's on_update event.
+    #
+    # @yieldparam [Character]
+    # @yieldparam [SceneData::Base]
     def on_finish &block
       @finish = block
     end
 
+    # Start the scene.
+    # This method typically gets called from the plot during the on_ready
+    # event and whenever a character cues a scene.
+    #
     def start actor
       data = start_data_for(actor)
       do_start_block actor, data
       data
     end
 
+    # End the scene.
+    # This method typically gets called from the plot during the on_update
+    # event.
+    #
     def finish actor, input
       data = finish_data_for(actor, input)
       do_finish_block actor, data
     end
 
+    # Get the text to be displayed to the user when receiving input.
+    #
+    # @return [String]
+    def prompt_for actor
+      return character_data[actor].prompt unless character_data[actor].nil?
+      '>'
+    end
+
     private
 
     def do_start_block actor, data
@@ -37,6 +74,19 @@ module Gamefic
       @finish.call actor, data unless @finish.nil?
     end
 
+    def character_data
+      @character_data ||= {}
+    end
+
+    def start_data_for actor
+      character_data[actor] ||= data_class.new
+    end
+
+    def finish_data_for actor, input
+      data = character_data[actor]
+      data.input = input.strip
+      data
+    end
   end
   
 end