gamefic-sdk 1.6.0 → 1.7.0

data/scripts/standard/lockable.plot.rb

@@ -0,0 +1,79 @@
+# @gamefic.script standard/lockable
+
+script 'standard/openable'
+
+module Lockable
+  include Openable
+
+  attr_accessor :lock_key
+
+  def locked=(bool)
+    @locked = bool
+    if @locked == true
+      self.open = false
+    end
+  end
+
+  def open=(bool)
+    @open = bool
+    @locked = false if @open == true
+  end
+
+  def locked?
+    @locked ||= false
+  end
+
+  def has_lock_key?
+    !@lock_key.nil?
+  end
+end
+
+respond :lock, Use.available do |actor, thing|
+  actor.tell "#{you.pronoun.Subj} #{you.contract you.verb.can + ' not'} lock #{the thing}."
+end
+
+respond :_toggle_lock, Use.available(Lockable, :has_lock_key?) do |actor, thing|
+  verb = thing.locked? ? 'unlock' : 'lock'
+  key = nil
+  if thing.lock_key.parent == actor
+    key = thing.lock_key
+  end
+  if key.nil?
+    actor.tell "#{you.pronoun.Subj} #{you.contract you.verb.do + ' not'} have any way to #{verb} #{the thing}."
+  else
+    actor.tell "#{you.pronoun.Subj} #{you.verb['verb']} #{the thing} with #{the key}."
+    thing.locked = !thing.locked?
+  end
+end
+
+respond :lock, Use.available(Lockable, :has_lock_key?), Use.children do |actor, thing, key|
+  if thing.lock_key == key
+    actor.perform :_toggle_lock, thing
+  else
+    actor.tell "#{you.pronoun.Subj} #{you.contract you.verb.can + ' not'} unlock #{the thing} with #{the key}."
+  end
+end
+
+respond :lock, Use.available(Lockable, :has_lock_key?), Use.available do |actor, thing, key|
+  actor.perform :take, key if key.parent != actor
+  actor.proceed if key.parent == actor
+end
+
+respond :unlock, Use.available do |actor, thing|
+  actor.tell "#{you.pronoun.Subj} #{you.contract you.verb.can + ' not'} unlock #{the thing}."
+end
+
+respond :unlock, Use.available(Lockable, :has_lock_key?), Use.children do |actor, thing, key|
+  if thing.lock_key == key
+    actor.perform :_toggle_lock, thing
+  else
+    actor.tell "#{you.pronoun.Subj} #{you.contract you.verb.can + ' not'} unlock #{the thing} with #{the key}."
+  end
+end
+
+respond :unlock, Use.available(Lockable, :has_lock_key?), Use.available do |actor, thing, key|
+  actor.perform :take, key if key.parent != actor
+  actor.proceed if key.parent == actor
+end
+
+interpret "lock :container with :key", "lock :container :key"

data/scripts/standard/modules.plot.rb

@@ -1,11 +1,9 @@
+script 'standard/modules/use'
 script 'standard/modules/attachable'
 script 'standard/modules/auto_takes'
-script 'standard/modules/darkenable'
 script 'standard/modules/enterable'
 script 'standard/modules/explicit_exits'
 script 'standard/modules/itemizable'
-script 'standard/modules/lockable'
-script 'standard/modules/openable'
 script 'standard/modules/parent-room'
 script 'standard/modules/portable'
-script 'standard/modules/transparent'
+script 'standard/modules/locale_description'

data/scripts/standard/modules/attachable.plot.rb

@@ -5,6 +5,7 @@ module Attachable
     end
     @attached
   end
+  
   def attached=(bool)
     @attached = bool
   end

data/scripts/standard/modules/locale_description.plot.rb

@@ -0,0 +1,20 @@
+# Add a locale description to entities.
+# In the standard library, itemizing the contents of a room will display an
+# entity's locale description instead of adding its name to a list.
+#
+# Example without locale descriptions:
+#   You are in a room.
+#   You see a book, a key, and a cup.
+#
+# Example with a locale description for the cup:
+#   You are in a room.
+#   You see a book and a key.
+#   A gold cup gleams in the candlelight.
+#
+module LocaleDescription
+  attr_writer :locale_description
+  
+  def locale_description
+    @locale_description ||= ''
+  end
+end

data/scripts/standard/{use.plot.rb → modules/use.plot.rb}

@@ -1,47 +1,51 @@
-module Gamefic::Use
-  def self.children *args
-    Gamefic::Query::Children.new *args
-  end
-
-  def self.family *args
-    Gamefic::Query::Family.new *args
-  end
-
-  def self.parent *args
-    Gamefic::Query::Parent.new *args
-  end
-
-  def self.siblings *args
-    Gamefic::Query::Siblings.new *args
-  end
-
-  def self.text *args
-    Gamefic::Query::Text.new *args
-  end
-
-  # @todo This query is a candidate for deprecation. It's probably not worth
-  # the trouble to maintain a separate query just for transparent containers.
-  #
-  def self.visible *args
-    Gamefic::Query::Family.new *args
-  end
-
-  # @todo This query is a candidate for deprecation. For now it's an alias for
-  # Use.available.
-  #
-  def self.reachable *args
-    Gamefic::Query::Available.new *args
-  end
-
-  def self.available *args
-    Gamefic::Query::Available.new *args
-  end
-
-  def self.room *args
-    Gamefic::Query::Room.new *args
-  end
-
-  def self.itself *args
-    Gamefic::Query::Room.new *args
-  end
-end
+module Use
+  def self.children *args
+    Gamefic::Query::Children.new *args
+  end
+
+  def self.family *args
+    Gamefic::Query::Family.new *args
+  end
+
+  def self.parent *args
+    Gamefic::Query::Parent.new *args
+  end
+
+  def self.siblings *args
+    Gamefic::Query::Siblings.new *args
+  end
+
+  def self.text *args
+    Gamefic::Query::Text.new *args
+  end
+
+  # @todo This query is a candidate for deprecation. It's probably not worth
+  # the trouble to maintain a separate query just for transparent containers.
+  #
+  def self.visible *args
+    Gamefic::Query::Family.new *args
+  end
+
+  # @todo This query is a candidate for deprecation. For now it's an alias for
+  # Use.available.
+  #
+  def self.reachable *args
+    Gamefic::Query::Available.new *args
+  end
+
+  def self.available *args
+    Gamefic::Query::Available.new *args
+  end
+
+  def self.room *args
+    Gamefic::Query::Room.new *args
+  end
+
+  def self.itself *args
+    Gamefic::Query::Room.new *args
+  end
+
+  def self.from objects, *args
+    Gamefic::Query::External.new objects, *args
+  end
+end

data/scripts/standard/openable.plot.rb

@@ -0,0 +1,43 @@
+# @gamefic.script standard/openable
+
+module Openable
+  attr_writer :openable
+  def open= bool
+    @open = bool
+  end
+  def open?
+    @open ||= false
+  end
+  def closed?
+    !open?
+  end
+  def accessible?
+    open?
+  end
+end
+
+respond :open, Use.available do |actor, thing|
+  actor.tell "You can't open #{the thing}."
+end
+
+respond :open, Use.available(Openable) do |actor, thing|
+  if thing.open?
+    actor.tell "#{The thing} is already open."
+  else
+    actor.tell "You open #{the thing}."
+    thing.open = true
+  end
+end
+
+respond :close, Use.available do |actor, thing|
+  actor.tell "You can't close #{the thing}."
+end
+
+respond :close, Use.available(Openable) do |actor, thing|
+  if thing.open?
+    actor.tell "You close #{the thing}."
+    thing.open = false
+  else
+    actor.tell "#{The thing} is already open."
+  end
+end

data/scripts/standard/pathfinder.plot.rb

@@ -1,9 +1,10 @@
-# Pathfinders provide the shortest route between two locations. The
-# destination needs to be accessible from the origin through portals. Note
-# that Pathfinders do not take into account portals that characters cannot
-# traverse, such as locked doors.
-#
-class Gamefic::Pathfinder
+# @gamefic.script standard/pathfinder
+#   Pathfinders provide the shortest route between two locations. The
+#   destination needs to be accessible from the origin through portals. Note
+#   that Pathfinders do not take into account portals that characters should
+#   not be able to traverse, such as locked doors.
+
+class Pathfinder
   # @return [Room]
   attr_reader :origin
   # @return [Room]
@@ -23,17 +24,21 @@ class Gamefic::Pathfinder
       end
     end
   end
+
   # @return [Array<Room>]
   def path
     # @path is nil if the path is invalid, but #path should return an empty
     # array instead.
     @path || []
   end
+
   # @return [Boolean]
   def valid?
     path.length > 0 or origin == destination
   end
+
   private
+
   def embark
     new_paths = []
     @paths.each { |path|

data/scripts/standard/test.plot.rb

@@ -1,3 +1,5 @@
+# @gamefic.script standard/test
+
 meta :test, Query::Text.new do |actor, name|
   sym = name.to_sym
   if test_procs[sym].nil?

data/scripts/undo.plot.rb

@@ -1,11 +1,13 @@
-script 'snapshots'
-
-meta :undo do |actor|
-  last = Snapshots.history.pop
-  if last.nil?
-    actor.tell "No previous turns are available."
-  else
-    restore last
-    actor.tell "Previous turn undone."
-  end
-end
+# @gamefic.script undo
+
+script 'snapshots'
+
+meta :undo do |actor|
+  last = Snapshots.history.pop
+  if last.nil?
+    actor.tell "No previous turns are available."
+  else
+    restore last
+    actor.tell "Previous turn undone."
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-sdk
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: opal
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +158,7 @@ files:
 - html/skins/standard/style.css
 - lib/gamefic-sdk.rb
 - lib/gamefic-sdk/build.rb
+- lib/gamefic-sdk/config.rb
 - lib/gamefic-sdk/debug.rb
 - lib/gamefic-sdk/debug/action.rb
 - lib/gamefic-sdk/debug/plot.rb
@@ -169,73 +170,49 @@ files:
 - lib/gamefic-sdk/platform/web/app_config.rb
 - lib/gamefic-sdk/platform/web/engine.rb
 - lib/gamefic-sdk/platform/web/user.rb
-- lib/gamefic-sdk/plot_config.rb
 - lib/gamefic-sdk/server.rb
 - lib/gamefic-sdk/shell.rb
 - lib/gamefic-sdk/shell/init.rb
 - lib/gamefic-sdk/shell/test.rb
 - lib/gamefic-sdk/version.rb
-- scripts/ansi.plot.rb
-- scripts/autosuggest.plot.rb
-- scripts/clothing.plot.rb
-- scripts/clothing/actions.plot.rb
-- scripts/clothing/actions/doff.plot.rb
-- scripts/clothing/actions/drop.plot.rb
-- scripts/clothing/actions/inventory.plot.rb
-- scripts/clothing/actions/wear.plot.rb
-- scripts/clothing/entities.plot.rb
-- scripts/clothing/entities/clothing.plot.rb
-- scripts/clothing/entities/coat.plot.rb
-- scripts/clothing/entities/gloves.plot.rb
-- scripts/clothing/entities/hat.plot.rb
-- scripts/clothing/entities/pants.plot.rb
-- scripts/clothing/entities/shirt.plot.rb
-- scripts/clothing/entities/shoes.plot.rb
-- scripts/cover.plot.rb
-- scripts/debug.plot.rb
-- scripts/edible.plot.rb
-- scripts/furniture.plot.rb
-- scripts/hints.plot.rb
-- scripts/hypertext.plot.rb
-- scripts/media.plot.rb
-- scripts/multimedia.plot.rb
-- scripts/questions.plot.rb
-- scripts/room-modes.plot.rb
-- scripts/rough-sizes.plot.rb
-- scripts/save-restore.plot.rb
+- scripts/save-restore-undo.plot.rb
 - scripts/snapshots.plot.rb
 - scripts/standard.plot.rb
 - scripts/standard/actions.plot.rb
-- scripts/standard/actions/close.plot.rb
 - scripts/standard/actions/drop.plot.rb
 - scripts/standard/actions/enter.plot.rb
-- scripts/standard/actions/give.plot.rb
 - scripts/standard/actions/go.plot.rb
 - scripts/standard/actions/insert.plot.rb
 - scripts/standard/actions/inventory.plot.rb
 - scripts/standard/actions/leave.plot.rb
-- scripts/standard/actions/lock.plot.rb
-- scripts/standard/actions/look-under.plot.rb
 - scripts/standard/actions/look.plot.rb
 - scripts/standard/actions/nil.plot.rb
-- scripts/standard/actions/open.plot.rb
 - scripts/standard/actions/place.plot.rb
 - scripts/standard/actions/quit.plot.rb
-- scripts/standard/actions/read.plot.rb
-- scripts/standard/actions/search.plot.rb
-- scripts/standard/actions/show.plot.rb
 - scripts/standard/actions/take.plot.rb
 - scripts/standard/actions/talk.plot.rb
-- scripts/standard/actions/unlock.plot.rb
-- scripts/standard/actions/use.plot.rb
 - scripts/standard/actions/wait.plot.rb
+- scripts/standard/clothing.plot.rb
+- scripts/standard/clothing/actions.plot.rb
+- scripts/standard/clothing/actions/doff.plot.rb
+- scripts/standard/clothing/actions/drop.plot.rb
+- scripts/standard/clothing/actions/inventory.plot.rb
+- scripts/standard/clothing/actions/wear.plot.rb
+- scripts/standard/clothing/entities.plot.rb
+- scripts/standard/clothing/entities/clothing.plot.rb
+- scripts/standard/clothing/entities/coat.plot.rb
+- scripts/standard/clothing/entities/gloves.plot.rb
+- scripts/standard/clothing/entities/hat.plot.rb
+- scripts/standard/clothing/entities/pants.plot.rb
+- scripts/standard/clothing/entities/shirt.plot.rb
+- scripts/standard/clothing/entities/shoes.plot.rb
+- scripts/standard/container.plot.rb
+- scripts/standard/container/actions.plot.rb
+- scripts/standard/container/entities.plot.rb
 - scripts/standard/direction.plot.rb
+- scripts/standard/edible.plot.rb
 - scripts/standard/entities.plot.rb
 - scripts/standard/entities/character.plot.rb
-- scripts/standard/entities/container.plot.rb
-- scripts/standard/entities/door.plot.rb
-- scripts/standard/entities/entity.plot.rb
-- scripts/standard/entities/exterior.plot.rb
 - scripts/standard/entities/fixture.plot.rb
 - scripts/standard/entities/item.plot.rb
 - scripts/standard/entities/portal.plot.rb
@@ -244,35 +221,23 @@ files:
 - scripts/standard/entities/rubble.plot.rb
 - scripts/standard/entities/scenery.plot.rb
 - scripts/standard/entities/supporter.plot.rb
+- scripts/standard/entities/thing.plot.rb
+- scripts/standard/give.plot.rb
+- scripts/standard/lockable.plot.rb
 - scripts/standard/modules.plot.rb
 - scripts/standard/modules/attachable.plot.rb
 - scripts/standard/modules/auto_takes.plot.rb
-- scripts/standard/modules/darkenable.plot.rb
 - scripts/standard/modules/enterable.plot.rb
 - scripts/standard/modules/explicit_exits.plot.rb
 - scripts/standard/modules/itemizable.plot.rb
-- scripts/standard/modules/lockable.plot.rb
-- scripts/standard/modules/openable.plot.rb
+- scripts/standard/modules/locale_description.plot.rb
 - scripts/standard/modules/parent-room.plot.rb
 - scripts/standard/modules/portable.plot.rb
-- scripts/standard/modules/transparent.plot.rb
+- scripts/standard/modules/use.plot.rb
+- scripts/standard/openable.plot.rb
 - scripts/standard/pathfinder.plot.rb
-- scripts/standard/plural.plot.rb
-- scripts/standard/plural/actions.plot.rb
-- scripts/standard/plural/actions/drop.plot.rb
-- scripts/standard/plural/actions/insert.plot.rb
-- scripts/standard/plural/actions/place.plot.rb
-- scripts/standard/plural/actions/take.plot.rb
-- scripts/standard/plural/queries.plot.rb
-- scripts/standard/plural/queries/ambiguous_visible.plot.rb
-- scripts/standard/plural/queries/any_expression.plot.rb
-- scripts/standard/plural/queries/many_visible.plot.rb
-- scripts/standard/plural/queries/not_expression.plot.rb
-- scripts/standard/plural/queries/plural_visible.plot.rb
 - scripts/standard/queries.plot.rb
 - scripts/standard/test.plot.rb
-- scripts/standard/use.plot.rb
-- scripts/suggestible.plot.rb
 - scripts/undo.plot.rb
 homepage: http://gamefic.com
 licenses: