gamefic 1.5.1 → 1.6.0

data/lib/gamefic/plot.rb

@@ -1,6 +1,5 @@
 # TODO: JSON support is currently experimental.
 #require 'gamefic/entityloader'
-require 'gamefic/stage'
 require 'gamefic/tester'
 require 'gamefic/source'
 require 'gamefic/script'
@@ -9,39 +8,37 @@ require 'gamefic/query'
 module Gamefic
 
   class Plot
-    autoload :SceneMount,   'gamefic/plot/scene_mount'
-    autoload :CommandMount, 'gamefic/plot/command_mount'
-    autoload :Entities,     'gamefic/plot/entities'
-    autoload :ArticleMount, 'gamefic/plot/article_mount'
-    autoload :YouMount,     'gamefic/plot/you_mount'
-    autoload :Snapshot,     'gamefic/plot/snapshot'
-    autoload :Host,         'gamefic/plot/host'
-    autoload :Players,      'gamefic/plot/players'
-    autoload :Playbook,     'gamefic/plot/playbook'
-    autoload :Callbacks,    'gamefic/plot/callbacks'
+    autoload :Scenes,    'gamefic/plot/scenes'
+    autoload :Commands,  'gamefic/plot/commands'
+    autoload :Entities,  'gamefic/plot/entities'
+    autoload :Articles,  'gamefic/plot/articles'
+    autoload :YouMount,  'gamefic/plot/you_mount'
+    autoload :Snapshot,  'gamefic/plot/snapshot'
+    autoload :Host,      'gamefic/plot/host'
+    autoload :Players,   'gamefic/plot/players'
+    autoload :Playbook,  'gamefic/plot/playbook'
+    autoload :Callbacks, 'gamefic/plot/callbacks'
+    autoload :Theater,   'gamefic/plot/theater'
 
     attr_reader :commands, :imported_scripts, :source
     # TODO: Metadata could use better protection
     attr_accessor :metadata
-    include Stage
-    # @!parse include Gamefic, Tester, Players, SceneMount, CommandMount, Entities
-    mount Gamefic, Tester, Players, SceneMount, CommandMount, Entities
-    # @!parse include ArticleMount, YouMount, Snapshot, Host, Callbacks
-    mount ArticleMount, YouMount, Snapshot, Host, Callbacks
-    expose :script, :metadata
+    include Theater
+    include Gamefic, Tester, Players, Scenes, Commands, Entities
+    include Articles, YouMount, Snapshot, Host, Callbacks
 
-    # @param [Source::Base]
+    # @param source [Source::Base]
     def initialize(source = nil)
       @source = source || Source::Text.new({})
       @working_scripts = []
       @imported_scripts = []
       @running = false
-      @playbook = Playbook.new
       post_initialize
     end
 
+    # @return [Gamefic::Plot::Playbook]
     def playbook
-      @playbook ||= Playbook.new
+      @playbook ||= Gamefic::Plot::Playbook.new
     end
 
     def running?
@@ -79,7 +76,9 @@ module Gamefic
     # Update the Plot's current turn of gameplay.
     # This method is typically called by the Engine that manages game execution.
     def update
-      p_players.each { |p| process_input p }
+      entities.each { |e| e.flush }
+      call_before_player_update
+      p_players.each { |p| p.scene.update }
       p_entities.each { |e| e.update }
       call_player_update
       call_update
@@ -106,24 +105,19 @@ module Gamefic
       end
       if !@working_scripts.include?(imported_script) and !imported_scripts.include?(imported_script)
         @working_scripts.push imported_script
-        stage imported_script.read, imported_script.absolute_path
+        # @hack Arguments need to be in different order if source returns proc
+        if imported_script.read.kind_of?(Proc)
+          stage &imported_script.read
+        else
+          stage imported_script.read, imported_script.absolute_path
+        end
         @working_scripts.pop
         imported_scripts.push imported_script
         true
       else
         false
       end
-    end
-    
-    private
-
-    def process_input player
-      line = player.queue.shift
-      if !line.nil?
-        player.scene.finish player, line
-      end
-    end
-
+    end    
   end
 
 end

data/lib/gamefic/plot/{article_mount.rb → articles.rb}

@@ -1,22 +1,22 @@
-module Gamefic
-  module Plot::ArticleMount
-    def a(entity)
-      entity.indefinitely
-    end
-    def an(entity)
-      entity.indefinitely
-    end
-    def the(entity)
-      entity.definitely
-    end
-    def A(entity)
-      entity.indefinitely.cap_first
-    end
-    def An(entity)
-      entity.indefinitely.cap_first
-    end
-    def The(entity)
-      entity.definitely.cap_first
-    end
-  end
-end
+module Gamefic
+  module Plot::Articles
+    def a(entity)
+      entity.indefinitely
+    end
+    def an(entity)
+      entity.indefinitely
+    end
+    def the(entity)
+      entity.definitely
+    end
+    def A(entity)
+      entity.indefinitely.cap_first
+    end
+    def An(entity)
+      entity.indefinitely.cap_first
+    end
+    def The(entity)
+      entity.definitely.cap_first
+    end
+  end
+end

data/lib/gamefic/plot/callbacks.rb

@@ -1,6 +1,6 @@
 module Gamefic
 
-  module Plot::Callbacks
+  module Plot::Callbacks    
     # Add a block to be executed on preparation of every turn.
     #
     # @example Increment a turn counter
@@ -35,6 +35,13 @@ module Gamefic
       p_player_ready_procs.push block
     end
 
+    # Add a block to be executed for each player before an update.
+    #
+    # @yieldparam[Character]
+    def before_player_update &block
+      p_before_player_update_procs.push block
+    end
+
     # Add a block to be executed for each player at the end of a turn.
     #
     # @yieldparam [Character]
@@ -58,15 +65,29 @@ module Gamefic
       p_update_procs.each { |p| p.call }
     end
 
+    # Execute the before_player_update blocks for each player. This method is
+    # typically called by the Plot while updating a turn, immediately before
+    # processing player input.
+    #
+    def call_before_player_update
+      p_players.each { |player|
+        player.flush
+        p_before_player_update_procs.each { |block| block.call player }
+      }
+    end
+
     # Execute the on_player_ready blocks for each player. This method is
     # typically called by the Plot while beginning a turn, immediately after
     # the on_ready blocks.
     #
     def call_player_ready
       p_players.each { |player|
-        this_scene = player.next_scene || player.scene
-        player.prepare nil
-        player.cue this_scene unless player.scene == this_scene
+        unless player.next_scene.nil?
+          player.cue player.next_scene
+        end
+        player.cue default_scene if player.scene.nil?
+        #player.prepare nil
+        #player.cue this_scene #unless player.scene.class == this_scene
         p_player_ready_procs.each { |block| block.call player }
       }
     end
@@ -77,6 +98,7 @@ module Gamefic
     #
     def call_player_update
       p_players.each { |player|
+        #player.performed nil
         p_player_update_procs.each { |block| block.call player }
       }
     end
@@ -89,6 +111,10 @@ module Gamefic
       @p_update_procs ||= []
     end
 
+    def p_before_player_update_procs
+      @p_before_player_update_procs ||= []
+    end
+
     def p_player_ready_procs
       @p_player_ready_procs ||= []
     end

data/lib/gamefic/plot/{command_mount.rb → commands.rb}

@@ -1,121 +1,121 @@
-require 'gamefic/action'
-
-module Gamefic
-
-  module Plot::CommandMount
-    # Create an Action that responds to a command.
-    # An Action uses the command argument to identify the imperative verb that
-    # triggers the action.
-    # It can also accept queries to tokenize the remainder of the input and
-    # filter for particular entities or properties.
-    # The block argument contains the code to be executed when the input
-    # matches all of the Action's criteria (i.e., verb and queries).
-    #
-    # @example A simple Action.
-    #   respond :salute do |actor|
-    #     actor.tell "Hello, sir!"
-    #   end
-    #   # The command "salute" will respond "Hello, sir!"
-    #
-    # @example An Action that accepts a Character
-    #   respond :salute, Use.visible(Character) do |actor, character|
-    #     actor.tell "#{The character} returns your salute."
-    #   end
-    #
-    # @param command [Symbol] An imperative verb for the command
-    # @param *queries [Array<Query::Base>] Queries to filter the command's tokens
-    # @yieldparam [Character]
-    def respond(command, *queries, &proc)
-      playbook.respond(command, *queries, &proc)
-    end
-
-    # Create a Meta Action that responds to a command.
-    # Meta Actions are very similar to standard Actions, except the Plot
-    # understands them to be commands that operate above and/or outside of the
-    # actual game world. Examples of Meta Actions are commands that report the
-    # player's current score, save and restore saved games, or list the game's
-    # credits.
-    #
-    # @example A simple Meta Action
-    #   meta :credits do |actor|
-    #     actor.tell "This game was written by John Smith."
-    #   end
-    #
-    # @param command [Symbol] An imperative verb for the command
-    # @param *queries [Array<Query::Base>] Queries to filter the command's tokens
-    # @yieldparam [Character]
-    def meta(command, *queries, &proc)
-      playbook.meta command, *queries, &proc
-    end
-
-    # @deprecated
-    def action(command, *queries, &proc)
-      respond command, *queries, &proc
-    end
-
-    # Declare a dismabiguation response for actions.
-    # The disambigurator is executed when an action expects an argument to
-    # reference a specific entity but its query matched more than one. For
-    # example, "red" might refer to either a red key or a red book.
-    #
-    # If a disambiguator is not defined, the playbook will use its default
-    # implementation.
-    #
-    # @example Tell the player the list of ambiguous entities.
-    #   disambiguate do |actor, entities|
-    #     actor.tell "I don't know which you mean: #{entities.join_or}."
-    #   end
-    #
-    # @yieldparam [Gamefic::Character]
-    # @yieldparam [Array<Gamefic::Entity>]
-    def disambiguate &block
-      playbook.disambiguate &block
-    end
-
-    # Validate an order before a character can execute its command.
-    #
-    # @yieldparam [Gamefic::Director::Order]
-    def validate &block
-      playbook.validate &block
-    end
-
-    # Create an alternate Syntax for an Action.
-    # The command and its translation can be parameterized.
-    #
-    # @example Create a synonym for the Inventory Action.
-    #   interpret "catalogue", "inventory"
-    #   # The command "catalogue" will be translated to "inventory"
-    #
-    # @example Create a parameterized synonym for the Look Action.
-    #   interpret "scrutinize :entity", "look :entity"
-    #   # The command "scrutinize chair" will be translated to "look chair"
-    #
-    # @param command [String] The format of the original command
-    # @param translation [String] The format of the translated command
-    # @return [Syntax] the Syntax object
-    def interpret command, translation
-      playbook.interpret command, translation
-    end
-
-    # @deprecated
-    def xlate command, translation
-      interpret command, translation
-    end
-
-    # Get an Array of available verbs.
-    # If the to_s parameter is true, convert Symbols to Strings.
-    #
-    # @return [Array<Symbol|String>]
-    def verbs to_s: false
-      to_s ? playbook.verbs.map { |v| v.to_s } : playbook.verbs
-    end
-
-    # Get an Array of all Actions defined in the Plot.
-    #
-    # @return [Array<Action>]
-    def actions
-      playbook.actions
-    end
-  end
-  
-end
+require 'gamefic/action'
+
+module Gamefic
+
+  module Plot::Commands
+    # Create an Action that responds to a command.
+    # An Action uses the command argument to identify the imperative verb that
+    # triggers the action.
+    # It can also accept queries to tokenize the remainder of the input and
+    # filter for particular entities or properties.
+    # The block argument contains the code to be executed when the input
+    # matches all of the Action's criteria (i.e., verb and queries).
+    #
+    # @example A simple Action.
+    #   respond :salute do |actor|
+    #     actor.tell "Hello, sir!"
+    #   end
+    #   # The command "salute" will respond "Hello, sir!"
+    #
+    # @example An Action that accepts a Character
+    #   respond :salute, Use.visible(Character) do |actor, character|
+    #     actor.tell "#{The character} returns your salute."
+    #   end
+    #
+    # @param command [Symbol] An imperative verb for the command
+    # @param queries [Array<Query::Base>] Filters for the command's tokens
+    # @yieldparam [Character]
+    def respond(command, *queries, &proc)
+      playbook.respond(command, *queries, &proc)
+    end
+
+    # Create a Meta Action that responds to a command.
+    # Meta Actions are very similar to standard Actions, except the Plot
+    # understands them to be commands that operate above and/or outside of the
+    # actual game world. Examples of Meta Actions are commands that report the
+    # player's current score, save and restore saved games, or list the game's
+    # credits.
+    #
+    # @example A simple Meta Action
+    #   meta :credits do |actor|
+    #     actor.tell "This game was written by John Smith."
+    #   end
+    #
+    # @param command [Symbol] An imperative verb for the command
+    # @param queries [Array<Query::Base>] Filters for the command's tokens
+    # @yieldparam [Character]
+    def meta(command, *queries, &proc)
+      playbook.meta command, *queries, &proc
+    end
+
+    # @deprecated
+    def action(command, *queries, &proc)
+      respond command, *queries, &proc
+    end
+
+    # Declare a dismabiguation response for actions.
+    # The disambigurator is executed when an action expects an argument to
+    # reference a specific entity but its query matched more than one. For
+    # example, "red" might refer to either a red key or a red book.
+    #
+    # If a disambiguator is not defined, the playbook will use its default
+    # implementation.
+    #
+    # @example Tell the player the list of ambiguous entities.
+    #   disambiguate do |actor, entities|
+    #     actor.tell "I don't know which you mean: #{entities.join_or}."
+    #   end
+    #
+    # @yieldparam [Gamefic::Character]
+    # @yieldparam [Array<Gamefic::Entity>]
+    def disambiguate &block
+      playbook.disambiguate &block
+    end
+
+    # Validate an order before a character can execute its command.
+    #
+    # @yieldparam [Gamefic::Director::Order]
+    def validate &block
+      playbook.validate &block
+    end
+
+    # Create an alternate Syntax for an Action.
+    # The command and its translation can be parameterized.
+    #
+    # @example Create a synonym for the Inventory Action.
+    #   interpret "catalogue", "inventory"
+    #   # The command "catalogue" will be translated to "inventory"
+    #
+    # @example Create a parameterized synonym for the Look Action.
+    #   interpret "scrutinize :entity", "look :entity"
+    #   # The command "scrutinize chair" will be translated to "look chair"
+    #
+    # @param command [String] The format of the original command
+    # @param translation [String] The format of the translated command
+    # @return [Syntax] the Syntax object
+    def interpret command, translation
+      playbook.interpret command, translation
+    end
+
+    # @deprecated
+    def xlate command, translation
+      interpret command, translation
+    end
+
+    # Get an Array of available verbs.
+    # If the to_s parameter is true, convert Symbols to Strings.
+    #
+    # @return [Array<Symbol|String>]
+    def verbs to_s: false
+      to_s ? playbook.verbs.map { |v| v.to_s } : playbook.verbs
+    end
+
+    # Get an Array of all Actions defined in the Plot.
+    #
+    # @return [Array<Action>]
+    def actions
+      playbook.actions
+    end
+  end
+  
+end