gamefic 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab6b04620f4d61106e3d7a3321dfc1833f0a7cce7eeb0e509ca77bdc5388d7c0
-  data.tar.gz: d8d37b580f71e20870cbe4124a8af41a953448b4bd5296e8f6f73d5e8a0e5092
+  metadata.gz: e5aaa5c2e7e709434b596c7bd216138ccc693d3893c56ed87ee54640e545d729
+  data.tar.gz: a7f12b8da551d9f97b279e6050333561e5d348940681cab7cf894f97a9eca085
 SHA512:
-  metadata.gz: ac226d280d8e1a07ad2bc154ae1cbc49a4496a847986f4d8919aef89999386432122673b568c64e2012ef3b910652aa67a31545e59eb65633105854fd0228d4b
-  data.tar.gz: 2b271b4061e74ab43d4cd11e080261b595404f7add90ea017934e49c4d1beda47a44c3ed88b53d4ba57cc6a6602fabf5e330a18544e783b09c56129642f6f82a
+  metadata.gz: b15fe4c2f586a9164a3166273c15638e548fbcf78d3f3e5bef41f55a8c054c06f1d5a16c62cbb13a252e635e0416c5fcb6da1f8574a1ac3323bb117d76f78fea
+  data.tar.gz: d26cb35d5a6fcae8f4c3511e2b22339491b5773d2288914c1125eeb38da4db51440e5780c28b1b4aec0344bb819f4abb97323d9ef5bcf21404667edf28705fe7

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## 4.0.0
+## 4.1.0 - February 1, 2025
+- Correct Scenes#pause block
+
+## 4.0.1 - January 26, 2025
+- Cue#prepare flushes messages
+
+## 4.0.0 - January 25, 2025
 - Nuanced scans
 - Command hooks
 - Refactored queries

data/lib/gamefic/active/cue.rb

@@ -66,7 +66,7 @@ module Gamefic
         props.output.merge!({
                               scene: scene.to_hash,
                               prompt: props.prompt,
-                              messages: actor.messages,
+                              messages: actor.flush,
                               queue: actor.queue
                             })
         actor.narratives.player_output_blocks.each { |block| block.call actor, props.output }
@@ -94,7 +94,6 @@ module Gamefic
 
       # @return [void]
       def prepare_output
-        scene
         props.output.last_input = actor.last_cue&.props&.input
         props.output.last_prompt = actor.last_cue&.props&.prompt
       end

data/lib/gamefic/scanner.rb

@@ -17,7 +17,7 @@ module Gamefic
     #
     # @param selection [Array<Entity>]
     # @param token [String]
-    # @param use [Array<Scanner::Base>]
+    # @param use [Array<Class<Scanner::Base>>]
     # @return [Result]
     def self.scan(selection, token, use = processors)
       result = nil

data/lib/gamefic/scene/base.rb

@@ -13,7 +13,7 @@ module Gamefic
 
       # @param actor [Actor]
       # @param narrative [Narrative]
-      # @param props [Props::Base]
+      # @param props [Props::Default]
       def initialize(actor, narrative = nil, props = nil, **context)
         @actor = actor
         @narrative = narrative
@@ -96,14 +96,14 @@ module Gamefic
         end
 
         # @yieldparam [Actor] The scene's actor
-        # @yieldparam [Props::Base] The scene's props
+        # @yieldparam [Props::Default] The scene's props
         # @yieldparam [Hash] Additional context
         def on_start(&block)
           start_blocks.push block
         end
 
         # @yieldparam [Actor] The scene's actor
-        # @yieldparam [Props::Base] The scene's props
+        # @yieldparam [Props::Default] The scene's props
         # @yieldparam [Hash] Additional context
         def on_finish(&block)
           finish_blocks.push block
@@ -113,7 +113,7 @@ module Gamefic
 
         attr_writer :context
 
-        # @param klass [Class<Props::Base>]
+        # @param klass [Class<Props::Default>]
         def use_props_class(klass)
           @props_class = klass
         end

data/lib/gamefic/scriptable/queries.rb

@@ -21,7 +21,7 @@ module Gamefic
       # descendants of siblings and children.
       #
       # @param args [Array<Object>] Query arguments
-      # @return [Query::Scoped]
+      # @return [Query::Family]
       def available *args
         Query::Family.new(*args, name: 'available')
       end
@@ -31,7 +31,7 @@ module Gamefic
       # Define a query that returns the actor's parent.
       #
       # @param args [Array<Object>] Query arguments
-      # @return [Query::Scoped]
+      # @return [Query::Parent]
       def parent *args
         Query::Parent.new(*args, name: 'parent')
       end
@@ -39,7 +39,7 @@ module Gamefic
       # Define a query that searches an actor's children.
       #
       # @param args [Array<Object>] Query arguments
-      # @return [Query::Scoped]
+      # @return [Query::Children]
       def children *args
         Query::Children.new(*args, name: 'children')
       end
@@ -47,7 +47,7 @@ module Gamefic
       # Define a query that searches an actor's descendants.
       #
       # @param args [Array<Object>] Query arguments
-      # @return [Query::Scoped]
+      # @return [Query::Descendants]
       def descendants *args
         Query::Descendants.new(*args)
       end
@@ -55,7 +55,7 @@ module Gamefic
       # Define a query that searches an actor's siblings.
       #
       # @param args [Array<Object>] Query arguments
-      # @return [Query::Scoped]
+      # @return [Query::Siblings]
       def siblings *args
         Query::Siblings.new(*args, name: 'siblings')
       end
@@ -63,7 +63,7 @@ module Gamefic
       # Define a query that searches an actor's siblings and their descendants.
       #
       # @param args [Array<Object>] Query arguments
-      # @return [Query::Scoped]
+      # @return [Query::Extended]
       def extended *args
         Query::Extended.new(*args, name: 'extended')
       end
@@ -71,7 +71,7 @@ module Gamefic
       # Define a query that returns the actor itself.
       #
       # @param args [Array<Object>] Query arguments
-      # @return [Query::Scoped]
+      # @return [Query::Myself]
       def myself *args
         Query::Myself.new(*args, name: 'myself')
       end
@@ -93,6 +93,7 @@ module Gamefic
       # a string representation of an integer. A successful query returns the
       # integer instead of an entity.
       #
+      # @return [Query::Integer]
       def integer
         Query::Integer.new name: 'integer'
       end

data/lib/gamefic/scriptable/scenes.rb

@@ -114,16 +114,26 @@ module Gamefic
         block Class.new(Scene::YesOrNo, &block), name
       end
 
+      # Create an active choice scene.
+      #
       # @param name [Symbol, nil]
       # @return [Class<Scene::ActiveChoice>]
       def active_choice(name = nil, &block)
         block Class.new(Scene::ActiveChoice, &block), name
       end
 
+      # Create a pause.
+      # The block will be executed at the start of the scene and the player
+      # will be prompted to press enter to continue.
+      #
       # @param name [Symbol, nil]
+      # @yieldparam [Actor]
+      # @yieldparam [Props::Default]
       # @return [Class<Scene::Pause>]
       def pause(name = nil, &block)
-        block Class.new(Scene::Pause, &block), name
+        block(Class.new(Scene::Pause) do
+          on_start(&block)
+        end, name)
       end
 
       # Create a conclusion.
@@ -136,6 +146,8 @@ module Gamefic
       #   end
       #
       # @param name [Symbol, nil]
+      # @yieldparam [Actor]
+      # @yieldparam [Props::Default]
       # @return [Class<Scene::Conclusion>]
       def conclusion(name = nil, &block)
         block(Class.new(Scene::Conclusion) do

data/lib/gamefic/scriptable/seeds.rb

@@ -3,10 +3,22 @@
 module Gamefic
   module Scriptable
     module Seeds
+      # @return [Array<Proc>]
       def seeds
         @seeds ||= []
       end
 
+      # Set methods and procs that get executed when a narrative gets initialized.
+      #
+      # @example
+      #   class Example < Gamefic::Plot
+      #     attr_reader :thing
+      #
+      #     seed do
+      #       @thing = make Entity, name: 'thing'
+      #     end
+      #   end
+      #
       def seed *methods, &block
         seeds.push(proc { methods.flatten.each { |method| send(method) } }) unless methods.empty?
         seeds.push block if block

data/lib/gamefic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gamefic
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 2025-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal