gamefic-standard 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8449554314b654b07a264e2d7726bbedac25212a65cc0feba5aea75c32e120c4
-  data.tar.gz: 2d1bedb7f9f780db43afc42994676e22625fc434bf46dfa16ccf7f6340217266
+  metadata.gz: 755a0c99a63ecce4d48bbbf7381e744c0b7bba4afe57d63c77a8d7febbeba51c
+  data.tar.gz: dcd68b55305fa872123273e76bec293bacf3b396608249291f483d3f01627bf9
 SHA512:
-  metadata.gz: a2bba15cb8c073bc68182f773fcc6b5b6b658ff4556d8995588c6ee2950598494e941d3e260693103e1f17f903d84ba5ea29cac36f75e65de6bf7e3fb3201a0c
-  data.tar.gz: e0c0999196d96e5a44f855fa76f3310b58acca624de2fc3d51bc95b8d74f1e6e6600c7b83f742ec79590e70aa5dbdfb92478deaa4d9dc3231092b5781963bd0e
+  metadata.gz: 19c17e7ae751826ef14a8533b406b2d9d978fbaad606949aebd2547f34a4a6ee7a901613e4d128694c784e8a8cf993b3c60d8cb6ba050de46a80e70455e0ff55
+  data.tar.gz: f10f11412b6128ec91057c060ef418fd54789cd9d616c24178b4e2c070f00cf5c4c478f56e49fe07eea029d29114c11df14566c1826d00bb962f7e581702cb13

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.2.0 - June 21, 2021
+- Insert, place, and wear try take first
+- Improved verb recognition
+- Openable doors
+
 # 2.1.0 - March 7, 2021
 - Remove sticky attribute
 - Use set_player_class

data/lib/gamefic-standard.rb

@@ -9,3 +9,4 @@ require 'gamefic-standard/direction'
 require 'gamefic-standard/entities'
 require 'gamefic-standard/actions'
 require 'gamefic-standard/container'
+require 'gamefic-standard/door'

data/lib/gamefic-standard/actions/go.rb

@@ -24,27 +24,27 @@ Gamefic.script do
     actor.tell "Where do you want to go?"
   end
 
-  xlate "north", "go north"
-  xlate "south", "go south"
-  xlate "west", "go west"
-  xlate "east", "go east"
-  xlate "up", "go up"
-  xlate "down", "go down"
-  xlate "northwest", "go northwest"
-  xlate "northeast", "go northeast"
-  xlate "southwest", "go southwest"
-  xlate "southeast", "go southeast"
+  interpret "north", "go north"
+  interpret "south", "go south"
+  interpret "west", "go west"
+  interpret "east", "go east"
+  interpret "up", "go up"
+  interpret "down", "go down"
+  interpret "northwest", "go northwest"
+  interpret "northeast", "go northeast"
+  interpret "southwest", "go southwest"
+  interpret "southeast", "go southeast"
 
-  xlate "n", "go north"
-  xlate "s", "go south"
-  xlate "w", "go west"
-  xlate "e", "go east"
-  xlate "u", "go up"
-  xlate "d", "go down"
-  xlate "nw", "go northwest"
-  xlate "ne", "go northeast"
-  xlate "sw", "go southwest"
-  xlate "se", "go southeast"
+  interpret "n", "go north"
+  interpret "s", "go south"
+  interpret "w", "go west"
+  interpret "e", "go east"
+  interpret "u", "go up"
+  interpret "d", "go down"
+  interpret "nw", "go northwest"
+  interpret "ne", "go northeast"
+  interpret "sw", "go southwest"
+  interpret "se", "go southeast"
 
   interpret "go to :place", "go :place"
 end

data/lib/gamefic-standard/actions/insert.rb

@@ -1,20 +1,13 @@
-# script 'standard'
 Gamefic.script do
   respond :insert, Use.available, Use.available do |actor, thing, target|
     actor.tell "You can't put #{the thing} inside #{the target}."
   end
 
-  respond :insert, Use.children, Use.available(Receptacle) do |actor, thing, receptacle|
-    actor.tell "You put #{the thing} in #{the receptacle}."
-    thing.parent = receptacle
-  end
-
   respond :insert, Use.available, Use.available(Receptacle) do |actor, thing, receptacle|
-    if thing.parent == actor
-      actor.proceed
-    else
-      actor.tell "You don't have #{the thing}."
-    end
+    actor.perform :take, thing unless thing.parent == actor
+    next unless thing.parent == actor
+    thing.parent = receptacle
+    actor.tell "You put #{the thing} in #{the receptacle}."
   end
 
   interpret "drop :item in :container", "insert :item :container"

data/lib/gamefic-standard/actions/nil.rb

@@ -1,7 +1,8 @@
 Gamefic.script do
   meta nil, Gamefic::Query::Text.new do |actor, string|
     words = string.split_words
-    list = verbs
+    # @todo There should probably be an Active#verbs or Active#command_words method
+    list = actor.playbooks.flat_map(&:syntaxes).flat_map(&:first_word)
     if list.include?(words[0])
       if words.length > 1
         found = Gamefic::Query::Available.new.resolve(actor, words[1..-1].join(' ')).objects

data/lib/gamefic-standard/actions/place.rb

@@ -3,14 +3,11 @@ Gamefic.script do
     actor.tell "You can't put #{the thing} on #{the supporter}."
   end
 
-  respond :place, Use.visible, Use.reachable(Supporter) do |actor, thing, supporter|
-    if thing.parent != actor
-      actor.perform :take, thing
-    end
-    if thing.parent == actor
-      thing.parent = supporter
-      actor.tell "You put #{the thing} on #{the supporter}."
-    end
+  respond :place, Use.available, Use.available(Supporter) do |actor, thing, supporter|
+    actor.perform :take, thing unless thing.parent == actor
+    next unless thing.parent == actor
+    thing.parent = supporter
+    actor.tell "You put #{the thing} on #{the supporter}."
   end
 
   respond :place, Use.children, Use.reachable(Supporter) do |actor, thing, supporter|
@@ -18,7 +15,7 @@ Gamefic.script do
     actor.tell "You put #{the thing} on #{the supporter}."
   end
 
-  respond :place, Use.visible, Use.text do |actor, thing, supporter|
+  respond :place, Use.visible, Use.text do |actor, _thing, supporter|
     actor.tell "You don't see anything called \"#{supporter}\" here."
   end
 
@@ -30,10 +27,10 @@ Gamefic.script do
     actor.tell "I don't know what you mean by \"#{thing}\" or \"#{supporter}.\""
   end
 
-  xlate "put :thing on :supporter", "place :thing :supporter"
-  xlate "put :thing down on :supporter", "place :thing :supporter"
-  xlate "set :thing on :supporter", "place :thing :supporter"
-  xlate "set :thing down on :supporter", "place :thing :supporter"
-  xlate "drop :thing on :supporter", "place :thing :supporter"
-  xlate "place :thing on :supporter", "place :thing :supporter"
+  interpret "put :thing on :supporter", "place :thing :supporter"
+  interpret "put :thing down on :supporter", "place :thing :supporter"
+  interpret "set :thing on :supporter", "place :thing :supporter"
+  interpret "set :thing down on :supporter", "place :thing :supporter"
+  interpret "drop :thing on :supporter", "place :thing :supporter"
+  interpret "place :thing on :supporter", "place :thing :supporter"
 end

data/lib/gamefic-standard/clothing/actions/doff.rb

@@ -8,7 +8,7 @@ Gamefic.script do
     end
   end
 
-  xlate "remove :clothing", "doff :clothing"
-  xlate "take off :clothing", "doff :clothing"
-  xlate "take :clothing off", "doff :clothing"
+  interpret "remove :clothing", "doff :clothing"
+  interpret "take off :clothing", "doff :clothing"
+  interpret "take :clothing off", "doff :clothing"
 end

data/lib/gamefic-standard/clothing/actions/wear.rb

@@ -1,8 +1,7 @@
 Gamefic.script do
   respond :wear, Use.available(Clothing) do |actor, clothing|
-    if clothing.parent != actor
-      actor.tell "You don't have #{the clothing}."
-    end
+    actor.perform :take, clothing unless clothing.parent == actor
+    next unless clothing.parent == actor
     if clothing.attached?
       actor.tell "You're already wearing #{the clothing}."
     else
@@ -16,7 +15,7 @@ Gamefic.script do
     end
   end
 
-  xlate "put on :clothing", "wear :clothing"
-  xlate "put :clothing on", "wear :clothing"
-  xlate "don :clothing", "wear :clothing"
+  interpret "put on :clothing", "wear :clothing"
+  interpret "put :clothing on", "wear :clothing"
+  interpret "don :clothing", "wear :clothing"
 end

data/lib/gamefic-standard/direction.rb

@@ -1,53 +1,54 @@
 class Direction
   include Gamefic::Serialize
 
-  attr_accessor :name, :adjective, :adverb, :reverse
+  attr_writer :adjective, :adverb, :reverse
 
-  def initialize args = {}
+  # @return [String]
+  attr_accessor :name
+
+  def initialize **args
     args.each { |key, value|
       send "#{key}=", value
     }
-    if !reverse.nil?
-      reverse.reverse = self
-    end
   end
 
+  # @return [String]
   def adjective
     @adjective || @name
   end
 
+  # @return [String]
   def adverb
     @adverb || @name
   end
 
-  def reverse=(dir)
-    @reverse = dir
-  end
-
+  # @return [String]
   def synonyms
     "#{adjective} #{adverb}"
   end
 
+  def reverse
+    Direction.find @reverse
+  end
+
   def to_s
     @name
   end
 
   class << self
     def compass
-      if @compass.nil?
-        @compass = {}
-        @compass[:north] = Direction.new(:name => 'north', :adjective => 'northern')
-        @compass[:south] = Direction.new(:name => 'south', :adjective => 'southern', :reverse => @compass[:north])
-        @compass[:west] = Direction.new(:name => 'west', :adjective => 'western')
-        @compass[:east] = Direction.new(:name => 'east', :adjective => 'eastern', :reverse => @compass[:west])
-        @compass[:northwest] = Direction.new(:name => 'northwest', :adjective => 'northwestern')
-        @compass[:southeast] = Direction.new(:name => 'southeast', :adjective => 'southeastern', :reverse => @compass[:northwest])
-        @compass[:northeast] = Direction.new(:name => 'northeast', :adjective => 'northeastern')
-        @compass[:southwest] = Direction.new(:name => 'southwest', :adjective => 'southwestern', :reverse => @compass[:northeast])
-        @compass[:up] = Direction.new(:name => 'up', :adjective => 'upwards')
-        @compass[:down] = Direction.new(:name => 'down', :adjective => 'downwards', :reverse => @compass[:up])
-      end
-      @compass
+      @compass ||= {
+        north: Direction.new(name: 'north', adjective: 'northern', reverse: :south),
+        south: Direction.new(name: 'south', adjective: 'southern', reverse: :north),
+        west: Direction.new(name: 'west', adjective: 'western', reverse: :east),
+        east: Direction.new(name: 'east', adjective: 'eastern', reverse: :west),
+        northwest: Direction.new(name: 'northwest', adjective: 'northwestern', reverse: :southeast),
+        southeast: Direction.new(name: 'southeast', adjective: 'southeastern', reverse: :northwest),
+        northeast: Direction.new(name: 'northeast', adjective: 'northeastern', reverse: :southwest),
+        southwest: Direction.new(name: 'southwest', adjective: 'southwestern', reverse: :northeast),
+        up: Direction.new(name: 'up', adjective: 'upwards', reverse: :down),
+        down: Direction.new(name: 'down', adjective: 'downwards', reverse: :up)
+      }
     end
 
     # @param dir [Direction, string]

data/lib/gamefic-standard/door.rb

@@ -0,0 +1,49 @@
+require 'gamefic-standard/openable'
+
+# An openable portal.
+#
+class Door < Portal
+  include Openable
+  include Lockable
+
+  def post_initialize
+    update_reverse_open
+  end
+
+  def open= bool
+    super
+    update_reverse_open
+  end
+
+  def locked= bool
+    super
+    update_reverse_lock
+  end
+
+  def two_way_lock_key= key
+    lock_key = key
+    return if reverse.nil?
+    reverse.lock_key = key
+  end
+
+  private
+
+  def update_reverse_open
+    rev = find_reverse
+    return if rev.nil? || rev.open? == open?
+    rev.open = open?
+  end
+
+  def update_reverse_lock
+    rev = find_reverse
+    return if rev.nil? || rev.locked? == locked?
+    rev.locked = locked?
+  end
+end
+
+Gamefic.script do
+  respond :go, Use.available(Door) do |actor, door|
+    actor.perform :open, door unless door.open?
+    actor.proceed if door.open?
+  end
+end

data/lib/gamefic-standard/edible.rb

@@ -1,23 +1,23 @@
-# @gamefic.script standard/edible
-
-module Edibility
-  attr_writer :edible
-  def edible?
-    @edible ||= false
-  end
-end
-
-class Thing
-  include Edibility
-end
-
-Gamefic.script do
-  respond :eat, Use.available do |actor, item|
-    actor.tell "You can't eat #{the item}."
-  end
-
-  respond :eat, Use.available(:edible?) do |actor, item|
-    actor.tell "You eat #{the item}."
-    destroy item
-  end
-end
+# @gamefic.script standard/edible
+
+module Edibility
+  attr_writer :edible
+  def edible?
+    @edible ||= false
+  end
+end
+
+class Thing
+  include Edibility
+end
+
+Gamefic.script do
+  respond :eat, Use.available do |actor, item|
+    actor.tell "You can't eat #{the item}."
+  end
+
+  respond :eat, Use.available(:edible?) do |actor, item|
+    actor.tell "You eat #{the item}."
+    destroy item
+  end
+end

data/lib/gamefic-standard/entities/portal.rb

@@ -15,12 +15,13 @@ class Portal < Thing
   # Find the portal in the destination that returns to this portal's parent
   #
   # @return [Room, nil]
-  def find_reverse
+  def reverse
     return nil if destination.nil?
     destination.children.that_are(Portal).find do |portal|
       portal.destination == parent
     end
   end
+  alias find_reverse reverse
 
   def direction= dir
     @direction = Direction.find(dir)

data/lib/gamefic-standard/entities/thing.rb

@@ -1,14 +1,17 @@
 class Thing < Gamefic::Entity
   include Grammar::Attributes
 
+  # @return [Boolean]
   attr_writer :itemized
 
+  # @return [Boolean]
   attr_writer :portable
 
   # An optional description to use when itemizing entities in room
   # descriptions. The locale_description will be used instead of adding
   # the entity's name to a list.
   #
+  # @return [String, nil]
   attr_accessor :locale_description
 
   set_default itemized: true

data/lib/gamefic-standard/lockable.rb

@@ -25,9 +25,14 @@ module Lockable
     @locked ||= false
   end
 
-  def has_lock_key?
+  def unlocked?
+    !locked?
+  end
+
+  def lock_key?
     !@lock_key.nil?
   end
+  alias has_lock_key? lock_key?
 end
 
 Gamefic.script do

data/lib/gamefic-standard/openable.rb

@@ -46,4 +46,9 @@ Gamefic.script do
       actor.tell "#{The thing} is already open."
     end
   end
+
+  respond :look, Use.available(Thing, Openable) do |actor, thing|
+    actor.proceed
+    actor.tell "#{The thing} is #{thing.open? ? 'open' : 'closed'}."
+  end
 end

data/lib/gamefic-standard/pathfinder.rb

@@ -7,9 +7,10 @@
 class Pathfinder
   # @return [Room]
   attr_reader :origin
+
   # @return [Room]
   attr_reader :destination
-  
+
   def initialize origin, destination
     @origin = origin
     @destination = destination
@@ -19,9 +20,7 @@ class Pathfinder
     if @origin == @destination
       @path = []
     else
-      while @path.nil? and @paths.length > 0
-        embark
-      end
+      embark while @path.nil? && @paths.length > 0
     end
   end
 
@@ -34,7 +33,7 @@ class Pathfinder
 
   # @return [Boolean]
   def valid?
-    path.length > 0 or origin == destination
+    path.length > 0 || origin == destination
   end
 
   private

data/lib/gamefic-standard/version.rb

@@ -1,5 +1,5 @@
 module Gamefic
   module Standard
-    VERSION = '2.1.0'
+    VERSION = '2.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-standard
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Fred Snyder
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -138,6 +138,7 @@ files:
 - lib/gamefic-standard/clothing/entities/shoes.rb
 - lib/gamefic-standard/container.rb
 - lib/gamefic-standard/direction.rb
+- lib/gamefic-standard/door.rb
 - lib/gamefic-standard/edible.rb
 - lib/gamefic-standard/entities.rb
 - lib/gamefic-standard/entities/character.rb
@@ -167,7 +168,7 @@ homepage: http://gamefic.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -182,8 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: The Gamefic standard script library.
 test_files: []