gamefic 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc53c7427d9e153ee3a41dfe297cf2c038733024a8d79c6feec8e648f6efd83a
-  data.tar.gz: 88be2b8ba3d282e762692f39ce63fde315609d0b2f9a766f0a99ede59554ba30
+  metadata.gz: e5aaa5c2e7e709434b596c7bd216138ccc693d3893c56ed87ee54640e545d729
+  data.tar.gz: a7f12b8da551d9f97b279e6050333561e5d348940681cab7cf894f97a9eca085
 SHA512:
-  metadata.gz: d97432e274e89b7202df2c5f1bebae60450db5c71813cf8f7c711997920fa1e41ca2a63e22bdb29b2e77b29b37174858e61e145004440b1dfa0c96403cd5d6b4
-  data.tar.gz: 89023cc5765cabb26c86848ae73fd2871b22015aaeeadd48307ddbea004cb1ecb9a857d3e870b63497fc19405d7e07848643ede4bd80bf90336057ba2d9d49be
+  metadata.gz: b15fe4c2f586a9164a3166273c15638e548fbcf78d3f3e5bef41f55a8c054c06f1d5a16c62cbb13a252e635e0416c5fcb6da1f8574a1ac3323bb117d76f78fea
+  data.tar.gz: d26cb35d5a6fcae8f4c3511e2b22339491b5773d2288914c1125eeb38da4db51440e5780c28b1b4aec0344bb819f4abb97323d9ef5bcf21404667edf28705fe7

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.1.0 - February 1, 2025
+- Correct Scenes#pause block
+
 ## 4.0.1 - January 26, 2025
 - Cue#prepare flushes messages
 

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.1'
+  VERSION = '4.1.0'
 end

metadata

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