gamefic 1.6.0 → 1.7.0

data/lib/gamefic/plot/entities.rb

@@ -18,7 +18,19 @@ module Gamefic
         end
         p_entities.push ent
         p_dynamic.push ent if running?
-        ent.playbook = playbook if ent.kind_of?(Character)
+        ent
+      end
+
+      # Cast an active entity.
+      # This method is similar to make, but it also provides the plot's
+      # playbook to the entity so it can perform actions. The entity should
+      # either be a kind of Gamefic::Actor or include the Gamefic::Active
+      # module.
+      #
+      # @return [Gamefic::Actor, Gamefic::Active]
+      def cast cls, args = {}, &block
+        ent = make cls, args, &block
+        ent.playbooks.push playbook
         ent
       end
 

data/lib/gamefic/plot/host.rb

@@ -14,30 +14,32 @@ module Gamefic
     #
     # @param subplot_class [Class] The class of the subplot to be created (Subplot by default)
     # @return [Subplot]
-    def branch subplot_class = Gamefic::Subplot, introduce: nil, next_cue: nil, busy_cue: nil
-      subplot = subplot_class.new(self, introduce: introduce, next_cue: next_cue, busy_cue: busy_cue)
+    def branch subplot_class = Gamefic::Subplot, introduce: nil, next_cue: nil
+      subplot = subplot_class.new(self, introduce: introduce, next_cue: next_cue)
       p_subplots.push subplot
       subplot
     end
 
-    # Get the player's current subplot or nil if none exists.
+    # Get the player's current subplots.
     #
-    # @return [Subplot]
-    def subplot_for player
+    # @return [Array<Subplot>]
+    def subplots_featuring player
+      result = []
       subplots.each { |s|
-        return s if s.players.include?(player)
+        result.push s if s.players.include?(player)
       }
-      nil
+      result
     end
 
     # Determine whether the player is involved in a subplot.
     #
     # @return [Boolean]
     def in_subplot? player
-      !subplot_for(player).nil?
+      !subplots_featuring(player).empty?
     end
 
     private
+
     def p_subplots
       @p_subplots ||= []
     end

data/lib/gamefic/plot/playbook.rb

@@ -131,14 +131,7 @@ module Gamefic
         if result.empty?
           result.concat dispatch_from_string(actor, command.join(' '))
         end
-        result.sort! { |a,b|
-          if a.rank == b.rank
-            b.order_key <=> a.order_key
-          else
-            b.rank <=> a.rank
-          end
-        }
-        result.uniq{|a| a.class}
+        result
       end
 
       def dispatch_from_string actor, text
@@ -147,11 +140,12 @@ module Gamefic
         commands.each { |c|
           available = actions_for(c.verb)
           available.each { |a|
+            next if a.hidden?
             o = a.attempt(actor, c.arguments)
             result.unshift o unless o.nil?
           }
         }
-        result
+        sort_and_reduce_actions result
       end
 
       def dispatch_from_params actor, verb, params
@@ -160,7 +154,7 @@ module Gamefic
         available.each { |a|
           result.unshift a.new(actor, params) if a.valid?(actor, params)
         }
-        result
+        sort_and_reduce_actions result
       end
 
       # Duplicate the playbook.
@@ -223,10 +217,20 @@ module Gamefic
         }
       end
 
+      def sort_and_reduce_actions arr
+        arr.sort { |a,b|
+          if a.rank == b.rank
+            b.order_key <=> a.order_key
+          else
+            b.rank <=> a.rank
+          end
+        }.uniq{|a| a.class}
+      end
+
       def raise_order_key
-        @order_key ||= 0
-        tmp = @order_key
-        @order_key += 1
+        @@order_key ||= 0
+        tmp = @@order_key
+        @@order_key += 1
         tmp
       end
 

data/lib/gamefic/plot/scenes.rb

@@ -2,7 +2,7 @@ module Gamefic
 
   module Plot::Scenes
     def default_scene
-      @default_scene ||= Scene::Active
+      @default_scene ||= Scene::Activity
     end
 
     def default_conclusion
@@ -19,7 +19,7 @@ module Gamefic
     #   end
     #
     # @yieldparam [Gamefic::Character]
-    def introduction (&proc)
+    def introduction(&proc)
       @introduction = proc
     end
 
@@ -28,7 +28,7 @@ module Gamefic
     #
     # @param [Gamefic::Character]
     def introduce(player)
-      player.playbook = playbook
+      player.playbooks.push playbook unless player.playbooks.include?(playbook)
       player.cue default_scene
       p_players.push player
       @introduction.call(player) unless @introduction.nil?
@@ -40,10 +40,12 @@ module Gamefic
     # @yieldparam [Gamefic::Character]
     # @yieldparam [Gamefic::Scene::Data::MultipleChoice]
     def multiple_choice *choices, &block
-      Scene::MultipleChoice.subclass do |actor, scene|
+      s = Scene::MultipleChoice.subclass do |actor, scene|
         scene.options.concat choices
         scene.on_finish &block
       end
+      scene_classes.push s
+      s
     end
     
     # Create a yes-or-no scene.
@@ -52,17 +54,30 @@ module Gamefic
     # @yieldparam [Gamefic::Character]
     # @yieldparam [Gamefic::Scene::YesOrNo]
     def yes_or_no prompt = nil, &block
-      Scene::YesOrNo.subclass do |actor, scene|
+      s = Scene::YesOrNo.subclass do |actor, scene|
         scene.prompt = prompt
         scene.on_finish &block
       end
+      scene_classes.push s
+      s
     end
-    
+
+    # Create a scene with custom processing on user input.
+    #
+    # @example Echo the user's response
+    #   @scene = question 'What do you say?' do |actor, scene|
+    #     actor.tell "You said #{scene.input}"
+    #   end
+    #
+    # @yieldparam [Gamefic::Character]
+    # @yieldparam [Gamefic::Scene::YesOrNo]
     def question prompt = 'What is your answer?', &block
-      Scene::Custom.subclass do |actor, scene|
+      s = Scene::Custom.subclass do |actor, scene|
         scene.prompt = prompt
         scene.on_finish &block
       end
+      scene_classes.push s
+      s
     end
 
     # Create a scene that pauses the game.
@@ -73,10 +88,12 @@ module Gamefic
     # @yieldparam [Gamefic::Character]
     # @yieldparam [Gamefic::Scene::Pause]
     def pause prompt = nil, &block
-      Scene::Pause.subclass do |actor, scene|
+      s = Scene::Pause.subclass do |actor, scene|
         scene.prompt = prompt unless prompt.nil?
         block.call(actor, scene) unless block.nil?
       end
+      scene_classes.push s
+      s
     end
     
     # Create a conclusion.
@@ -86,7 +103,9 @@ module Gamefic
     # @yieldparam [Gamefic::Character]
     # @yieldparam [Gamefic::Scene::Conclusion]
     def conclusion &block
-      Scene::Conclusion.subclass &block
+      s = Scene::Conclusion.subclass &block
+      scene_classes.push s
+      s
     end
     
     # Create a custom scene.
@@ -111,7 +130,9 @@ module Gamefic
     # @yieldparam [Gamefic::Character]
     # @yieldparam [Scene::Custom] The instantiated scene.
     def custom cls = Scene::Custom, &block
-      cls.subclass &block
+      s = cls.subclass &block
+      scene_classes.push s
+      s
     end
 
     # Choose a new scene based on a list of options.
@@ -133,16 +154,33 @@ module Gamefic
     #     actor.cue select_one_or_two # The actor will be prompted to select "one" or "two" and get sent to the corresponding scene
     #   end
     #
-    # @param map [Hash] A Hash of options and associated scene keys.
+    # @example Customize options
+    #   scene_one = pause # do...
+    #   scene_two = pause # do...
+    #
+    #   # Some event in the game sets actor[:can_go_to_scene_two] to true
+    #
+    #   select_one_or_two = multiple_scene do |actor, scene|
+    #     scene.map "Go to scene one", scene_one
+    #     scene.map "Go to scene two", scene_two if actor[:can_go_to_scene_two]
+    #   end
+    #
+    # @param map [Hash] A Hash of options and associated scenes.
     # @yieldparam [Gamefic::Character]
     # @yieldparam [Gamefic::Scene::MultipleScene]
     def multiple_scene map = {}, &block
-      Scene::MultipleScene.subclass do |actor, scene|
+      s = Scene::MultipleScene.subclass do |actor, scene|
         map.each_pair { |k, v|
           scene.map k, v
         }
         block.call actor, scene unless block.nil?
       end
+      scene_classes.push s
+      s
+    end
+
+    def scene_classes
+      @scene_classes ||= []
     end
   end
 

data/lib/gamefic/plot/snapshot.rb

@@ -2,226 +2,31 @@ require 'json'
 
 module Gamefic
   module Plot::Snapshot
-  
-    # Take a snapshot of the plot's current state.
-    # The snapshot is a hash with two keys: entities and subplots.
-    #
     # @return [Hash]
     def save
-      store = get_entity_hash
-      if @initial_state.nil?
-        @initial_state = store
-        store = []
-        @initial_state.length.times do
-          store.push {}
-        end
-      else
-        store = reduce(store)
-      end
-      return {
-        entities: store,
-        subplots: save_subplots,
-        metadata: metadata
-      }
-    end
-    
-    # Restore the plot to the state of the provided snapshot.
-    #
-    # @param snapshot [Hash]
-    def restore snapshot
-      restore_initial_state
-      internal_restore snapshot[:entities]
-      restore_subplots snapshot[:subplots]
-    end
-    
-    private
-    
-    # Restore the plot to the state of its first snapshot.
-    #
-    def restore_initial_state
-        p_entities[@initial_state.length..-1].each { |e|
-          e.parent = nil
-        }
-        p_entities.slice! @initial_state.length..-1
-        internal_restore @initial_state
-    end
-    
-    def get_entity_hash
-      store = []
-      entities.each { |e|
-        hash = {}
-        e.instance_variables.each { |k|
-          next if k == :@children
-          v = e.instance_variable_get(k)
-          hash[k] = v
-        }
-        hash[:class] = e.class.to_s
-        store.push serialize_object(hash)
-      }
-      store
-    end
-    
-    def internal_restore snapshot
-      index = 0
-      snapshot.each { |hash|
-        if entities[index].nil?
-          cls = Kernel.const_get(hash[:class])
-          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
-          entities[index].cue v.to_sym
-        elsif (k != :class)
-          entities[index].instance_variable_set(k, unserialize(v))
-        end
-      }
-      nil
-    end
-
-    def reduce entities
-      reduced = []
-      index = 0
-      entities.each { |e|
-        r = {}
-        e.each_pair { |k, v|
-          if index >= @initial_state.length or @initial_state[index][k] != v
-            r[k] = v
-          end
-        }
-        reduced.push r
-        index += 1
-      }
-      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]
-      allowed.each { |a|
-        return true if obj.kind_of?(a)
-      }
-      false
+      initial_state
+      internal_save
     end
 
-    def serialize_object obj
-      return nil if obj.nil?
-      return false if obj == false
-      if obj.kind_of?(Hash)
-        return serialize_hash obj
-      elsif obj.kind_of?(Array)
-        return serialize_array obj
-      else
-        if obj.kind_of?(Entity)
-          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|
-        if can_serialize?(k) and can_serialize?(v)
-          hash[serialize_object(k)] = serialize_object(v)
-        end
-      }
-      return hash
-    end
-
-    def serialize_array obj
-      arr = []
-      obj.each_index { |i|
-        if can_serialize?(obj[i])
-          arr[i] = serialize_object(obj[i])
-        else
-          raise "Bad array in snapshot"
-        end
-      }
-      return arr
+    def restore snapshot
+      # HACK Force conclusion of current subplots
+      p_subplots.each { |s| s.conclude }
+      p_subplots.clear
+      Gamefic::Plot::Darkroom.new(self).restore(snapshot)
+      entities.each { |e| e.flush }
     end
 
-    def unserialize obj
-      if obj.kind_of?(Hash)
-        unserialize_hash obj
-      elsif obj.kind_of?(Array)
-        unserialize_array obj
-      elsif obj.to_s.match(/^#<EIN_[0-9]+>$/)
-        i = obj[6..-2].to_i
-        p_entities[i]
-      elsif obj.to_s.match(/^#<DIR_[a-z]+>$/)
-        Direction.find(obj[6..-2])
-      else
-        obj
+    def initial_state
+      if @initial_state.nil?
+        @initial_state = internal_save
       end
+      @initial_state
     end
 
-    def unserialize_hash obj
-      hash = {}
-      obj.each_pair { |k, v|
-        hash[unserialize(k)] = unserialize(v)
-      }
-      hash
-    end
-
-    def unserialize_array obj
-      arr = []
-      obj.each_index { |i|
-        arr[i] = unserialize(obj[i])
-      }
-      arr
-    end
+    private
 
-    def save_subplots
-      # TODO: Subplot snapshots are temporarily disabled.
-      return []
-      arr = []
-      subplots.each { |s|
-        hash = {}
-        hash[:class] = s.class.to_s
-        s.instance_variables.each { |k|
-          v = s.instance_variable_get(k)
-          if can_serialize?(v)
-            hash[k] = serialize_object(v)
-          end
-        }
-        arr.push hash
-      }
-      arr
-    end
-    
-    def restore_subplots arr
-      # TODO: Subplot snapshots are temporarily disabled.
-      return
-      players.each { |p|
-        p.send(:p_subplots).clear
-      }
-      p_subplots.clear
-      arr.each { |hash|
-        cls = Kernel.const_get(hash[:class])
-        subplot = cls.new self
-        hash.each { |k, v|
-          if k != :class
-            subplot.instance_variable_set(k, unserialize(v))
-          end
-        }
-        subplot.players.each { |p|
-          p.send(:p_subplots).push subplot
-        }
-        subplot.entities.each { |e|
-          e.extend Subplot::Element
-          e.instance_variable_set(:@subplot, subplot)
-        }
-        p_subplots.push subplot
-      }
+    def internal_save
+      Gamefic::Plot::Darkroom.new(self).save
     end
   end
 end