twisty 0.0.2b → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 973c95d14cceffd3e604a89a4d3e13aa78668c79
-  data.tar.gz: 2890e7f27a04df943e73b0052b4bafeae65ef3a7
+  metadata.gz: 0c4b41c7bfe9c7ccc8ab8bda55ee1564de9d5940
+  data.tar.gz: 07135ce28c624d6b8d41dd5bd5cfd67d48764544
 SHA512:
-  metadata.gz: fcfbb0a47cc2baf7acb9e6c78999a96ed4e0b5ed50d0684ba0786faba2e7d529bbd500501db262eac72533483951c66be4c69593b67639669f5d553758f9f1ff
-  data.tar.gz: 91cef32321c07af3e9c27f0d6a31f625703de54ca1a8a4b706ff0a0e443a29a9619dd2b96c96533461d82aa3fc6bb049c8aea456bf6934fb6f330e1616fbfebd
+  metadata.gz: f9d9c48f2101a4aac3c01ed9c1c46b72608901289675d577f8696ccf7d0370e3320d40b7b18eb003f8ab8a02d234d7d1910c0b33c7017fea2c809f4af91754de
+  data.tar.gz: e68e5797a78c4bde6598087cd5e091b7b7840ef89acf420f3be863770036a1ad18ffd00f10603ebf2b72d6bc9a999cc8cdf1334f7dab0896d996dbfca778ac7e

data/lib/twisty/command.rb

@@ -7,17 +7,49 @@
 #                                                                           #
 #############################################################################
 
+require_relative 'engine.rb'
+
 require 'rtype'
 
 module Twisty
 
+#Used to provide the descriptions, examples of and executable code of commands
+#that the player can type.
 class Command
-	rtype_accessor :help1, :help2, String
-	rtype_accessor :func, Proc
+	#(+String+) An example of the command e.g. "take item"
+	attr_reader :help1
+	#(+String+) Short description of what the command actually does
+	attr_reader :help2
+
+	#Initialiser. Use Engine.define_command() instead
+	#
+	#help1:: (+String+) An example of the command e.g. "take item"
+	#help2:: (+String+) Short description of what the command actually does
+	#func:: (Proc) Code that provides the commands effect(s). *NOTE* This
+	#       must take exactly one argument of type +Array+[+String+]
 	def initialize(help1, help2, func)
 		@help1 = help1
 		@help2 = help2
-		@func = func
+
+		self.define_singleton_method(:exec, func)
+	end
+
+	#Executes this instance of command. This is redefined on a per-instance
+	#basis by Command.new().
+	#
+	#args:: (+Array+[+String+]) Words the player typed in
+	def exec(args)
+		return
+	end
+
+	protected
+	#(+Engine+)
+	#
+	#Convinience class so that each instances version of Command.exec() does
+	#not need to contain
+	#    engine = Engine.instance
+	def engine
+		Twisty::Engine.instance()
 	end
 end
 

data/lib/twisty/engine.rb

@@ -17,11 +17,20 @@ require_relative 'room.rb'
 
 module Twisty
 
+#Main class within Twisty.
 class Engine
 	include Singleton
 
-	attr_reader :items, :rooms, :inventory
+	#(+Hash+{+Symbol+ => +Item+}) All Items in the game regardless of if
+	#they have been placed anywhere
+	attr_reader :items
+	#(+Hash+{+Symbol+ => +Room+}) All Rooms in the game regardless of if
+	#they can be reached
+	attr_reader :rooms
+	#(+Array+[+Symbol+]) Keys of the Items the player is carrying
+	attr_reader :inventory
 
+	#Initialiser. As this class is a singleton use Engine.instance instead
 	def initialize
 		@items = {}
 		@rooms = {}
@@ -31,7 +40,7 @@ class Engine
 
 		@playing = nil
 
-		@commands = {} #Filled in lib/twisty.rb
+		@commands = {} #Filled in by lib/twisty.rb
 	end
 
 	################################
@@ -41,6 +50,21 @@ class Engine
 	# TODO: Make private "defining" method
 
 	rtype [Symbol, String, String, Hash] => nil
+	#Creates a new instance of Item in Engine.items indexed by id. Use this
+	#instead of Item.new().
+	#
+	#id:: (+Symbol+) Key within Engine.items
+	#name:: Name shown in "look" and used to "take" / "drop" the Item.
+	#       *NOTE* This MUST be a single word.
+	#desc:: (+String+) Long description shown when the player uses "look at"
+	#options:: (+Hash+{+Symbol+ => +Any}) Additional attributes of the Item
+	#
+	#          At present there are only two valid options that can be
+	#          passed via options:
+	#          fixed:: (+Boolean+) If set to true prevents "take" from
+	#                  working on the Item. Set to +false+ by default
+	#          storage:: (+Integer+) Indicates the number of other Items
+	#                    that this Item can contain. Set to +0+ by default
 	def define_item(id, name, desc, options={})
 		options = {fixed: false, storage: 0}.merge(options)
 
@@ -57,6 +81,13 @@ class Engine
 	end
 
 	rtype [Symbol, String, String] => nil
+	#Creates a new instance of Room in Engine.rooms indexed by id. Use this
+	#instead of Room.new().
+	#
+	#id:: (+Symbol+) Key for the Room in Engine.rooms
+	#name:: String (preferably one word) shown in the prompt when the player
+	#       is located in this Room
+	#desc:: (+String+) The long description of the player's current location
 	def define_room(id, name, desc)
 		room = Twisty::Room.new(id, name, desc)
 
@@ -75,6 +106,14 @@ class Engine
 	end
 
 	rtype [Symbol, Symbol, String] => nil
+	#Creates an exit from one Room to another
+	#
+	#from:: (+Symbol+) Key for the Room where the player is before using
+	#       "walk"
+	#to:: (+Symbol+) Key for the Room where the player is after using "walk"
+	#name:: (+String+) Used to name the _door_. This can be a word such as
+	#       "East" rather than the name of the destination. *NOTE* Must be
+	#       one word
 	def add_door(from, to, name)
 		if @rooms.has_key?(from)
 			if @rooms.has_key?(to)
@@ -90,6 +129,11 @@ class Engine
 	end
 
 	rtype [Symbol] => nil
+	#Change the the room that the player is currently in to the one
+	#represented by the Symbol id. Unlike Engine.goto() This does not print
+	#any information or trigger events.
+	#
+	#id:: (+Symbol+) Key of the Room where the player will go to
 	def current_room=(id)
 		if @rooms.has_key? id
 			@current_room = id
@@ -101,6 +145,12 @@ class Engine
 	end
 
 	rtype [] => nil
+	#Place an Item represented by the Symbol id. Unlike
+	#Engine.take_item_by_id() this does not remove the Item from any Room it
+	#may be in or trigger any events.
+	#
+	#id:: (+Symbol+) Key of the Item that will be added to the player's
+	#     inventory
 	def give(id)
 		if @items.include? id
 			@inventory << id
@@ -112,6 +162,16 @@ class Engine
 	end
 
 	rtype [Regexp, String, String, Proc] => nil
+	#Create a new command for the user to type. Not applicable for creating
+	#methods to develop the game with
+	#
+	#pattern:: (+Regexp+) Pattern that triggers the command to be run.
+	#*NOTE* Must be unique and unambigious
+	#help1:: (+String+) An example of the command. E.g. "take item"
+	#help2:: (+String+) A short description of what the command does
+	#&func:: (+Proc+) Code executed when the player types the command in.
+	#        *NOTE* Must take one argument of type +Array+[+String+] which
+	#        contains what the player typed
 	def define_command(pattern, help1, help2, &func)
 		@commands[pattern] = Command.new(help1, help2, func)
 		return nil
@@ -122,21 +182,34 @@ class Engine
 	#########################
 
 	rtype [] => Room
+	#(+Room+)
+	#
+	#The instance of Room that the player is currently in
 	def current_room
 		@rooms[@current_room]
 	end
 
 	rtype [] => Hash.of(Symbol, String)
+	#(+Hash+{+Symbol+ => +String+})
+	#
+	#Exits of the Room the player is currently in
 	def current_doors
 		@rooms[@current_room].doors
 	end
 	
 	rtype [] => Array.of(Symbol)
+	#(+Array+[+Symbol+])
+	#
+	#Keys of the Items present in the Room where the player is currently
+	#located
 	def current_items
 		@rooms[@current_room].items
 	end
 
 	rtype [] => Array.of(Symbol)
+	#(+Array+[+Symbol+])
+	#
+	#Items that the user is currently carrying
 	def inventory
 		@inventory
 	end
@@ -145,6 +218,9 @@ class Engine
 	#   Game play commands   #
 	##########################
 	rtype [String] => nil
+	#The "take item" command. Probably best not to call directly
+	#
+	#name:: (+String+) Name of an Item the player has typed in
 	def take_item_by_name(name)
 		current_items.each do |id|
 			if @items.has_key? id
@@ -163,6 +239,11 @@ class Engine
 	end
 
 	rtype [Symbol] => nil
+	#Called by Engine.take_item_by_name. Probably best not to call directly
+	#
+	#id:: (+Symbol+) Index entry for the Item to be removed from the current
+	#     room and placed in the player's inventory as found by
+	#     Engine.take_item_by_name()
 	def take_item_by_id(id)
 		if @items.has_key? id
 			if current_items.include? id
@@ -187,6 +268,12 @@ class Engine
 	end
 
 	rtype [String, String] => nil
+	#The "take item from item" command. Probably best not to call directly
+	#
+	#item:: (+String+) Name that the player has typed for an item to be
+	#       inventory
+	#container:: (+String+) Name of an Item that the player is looking to
+	#            remove added to the another Item from
 	def take_from_by_name_name(item, container)
 		current_items.each do |id|
 			if @items[id].name.downcase == container
@@ -200,6 +287,12 @@ class Engine
 	end
 
 	rtype [String, Symbol] => nil
+	#Called by take_from_by_name_name. Probably best not to call directly.
+	#
+	#item:: (+String+) Name that the player has typed for an item to be
+	#       added to the inventory
+	#container:: (+Symbol+) Key for the containing Item as found by
+	#            Engine.take_from_by_name_name
 	def take_from_by_name_id(item, container)
 		@items[container].contents.each do |id|
 			if @items[id].name.downcase == item
@@ -218,6 +311,10 @@ class Engine
 	end
 
 	rtype [String, String] => nil
+	#The "put item in item" command. Probably best not to call directly
+	#
+	#item:: (+String+) Name that the player has typed for an item to be
+	#       added to a container
 	def put_item_by_name_name(item, container)
 		@inventory.each do |id|
 			if @items[id].name.downcase == item
@@ -231,6 +328,13 @@ class Engine
 	end
 
 	rtype [Symbol, String] => nil
+	#Called by Engine.put_item_by_name_name. Probably best not to call
+	#directly
+	#
+	#item:: (+Symbol+) Key in Engine.items of the item to be placed in the
+	#       container as found by Engine.put_item_by_name_name
+	#container:: (+String+) Name that the player has typed for the Item
+	#            to act as a container
 	def put_item_by_id_name(item, container)
 		current_items.each do |id|
 			if @items[id].name.downcase == container
@@ -253,6 +357,10 @@ class Engine
 	end
 
 	rtype [String] => nil
+	#The "drop item" command. Probably best not to call directly
+	#
+	#name:: (+String+) The name, typed by the player, of the item to be
+	#dropped
 	def drop_item_by_name(name)
 		@inventory.each do |id|
 			if @items.has_key? id
@@ -272,6 +380,10 @@ class Engine
 	end
 
 	rtype [Symbol] => nil
+	#Called by Engine.drop_item_by_name. Probably best not to call directly
+	#
+	#id:: (+Symbol+) Key in Engine.items of the item to be dropped as found
+	#by Engine.drop_item_by_name
 	def drop_item_by_id(id)
 		if @items.has_key? id
 			if @items[id].drop_event
@@ -286,12 +398,17 @@ class Engine
 	end
 
 	rtype [Symbol] => nil
+	#Called by the "walk door" command. Unlike current_room=(id) this
+	#triggers events and only moves the player if said events run
+	#successfully
+	#
+	#id:: (+Symbol+) Key in Engine.rooms of the Room that the player will
+	#     be moved to
 	def goto(to)
 		if @rooms.has_key? to
 			if current_room.exit_event and @rooms[to].enter_event
 				@current_room = to
 			end
-			puts current_room.name
 		else
 			raise TwistyError.new "Room #{to} has not been defined"
 		end
@@ -304,15 +421,18 @@ class Engine
 	#######################
 
 	rtype [] => nil
+	#Starts the main loop of the game
+	#
+	#*NOTE* This must be included once and only once at the end of the
+	#program
 	def start_loop
 		@playing = true
 
-		puts current_room.name
-		puts
 		current_room.look
+		puts
 
 		while @playing == true
-			printf "> "
+			printf "#{current_room.name} > "
 			begin
 				line = gets
 				if line.class == NilClass
@@ -329,12 +449,14 @@ class Engine
 	end
 
 	rtype [] => nil
+	#Ends the main loop of the game. Use this for win and loose conditions
 	def end_loop
 		@playing = false
 		return nil
 	end
 
 	rtype [] => nil
+	#Called by start_loop to process user inpu.
 	def parse(line)
 		#Strip double spaces and downcase
 		tokens = line.downcase.split
@@ -342,8 +464,7 @@ class Engine
 
 		@commands.each do |pattern, command|
 			if line =~ pattern
-				#Execute as if a member function
-				instance_exec(tokens, &command.func)
+				command.exec(tokens)
 				return nil
 			end
 		end

data/lib/twisty/entity.rb

@@ -9,12 +9,26 @@
 
 require 'rtype'
 
+#Author:: Ryan McCoskrie (mailto:work@ryanmccoskrie.me)
+#Copyright:: Copyright (c) 2017 - 2018 RyanMcCoskrie
+#License:: MIT public license
+
 module Twisty
 
+#Super-class of Room and Item. Do not use directly.
+#
+#*NOTE* It is possible this class may be removed in future versions.
 class Entity
+	#(+Symbol+)The Symbol used to distinguish the Entity from other memebers
+	#of the same sub-class
 	attr_reader :id
 
 	rtype [Entity] => Boolean
+	#(+Boolean+)
+	#
+	#Checks if two different instances of Entity refer to the same datum
+	#
+	#other:: (+Entity+) instance of Entity to check for equality against
 	def ==(other)
 		if other.class == self.class
 			return other.id == @id
@@ -25,7 +39,9 @@ class Entity
 		end
 	end
 
-	protected
+	#(+Engine+)
+	#
+	#Convinience class to access the Engine
 	def engine
 		return Engine.instance()
 	end

data/lib/twisty/error.rb

@@ -9,16 +9,24 @@
 
 module Twisty
 
+#Super-class of GameError and PlayError. Do not use directly
 class TwistyError < RuntimeError
+	#(+String+) Message detailing the exception
 	attr_reader :message
 
+	#Initialiser
+	#
+	#s:: (+String+) Contents of TwistyError.message
 	def initialize(s)
 		@message = s
 	end
 end
 
+#Used when Twisty has found a bug in a specific game
 class GameError < TwistyError
 end
+
+#Used to tell the player when (s)he has used a command incorrectly
 class PlayError < TwistyError
 end
 

data/lib/twisty/item.rb

@@ -12,11 +12,34 @@ require_relative 'entity'
 require 'rtype'
 
 
+#Author:: Ryan McCoskrie (mailto:work@ryanmccoskrie.me)
+#Copyright:: Copyright (c) 2017 - 2018 RyanMcCoskrie
+#License:: MIT public license
+
 module Twisty
 
+# This class models objects that (movable and otherwise) that the character
+# can interact with.
 class Item < Entity
-	attr_reader :name, :desc, :fixed, :storage, :contents
-
+	#(+String+) One-word name of the Item
+	attr_reader :name
+	#(+String+) Description printed when the Item is looked at.
+	attr_reader :desc
+	#(+Boolean+) Indicates if the Item can not be moved
+	attr_reader :fixed
+	#(+Integer+) Number of other Items this instance can store
+	attr_reader :storage
+	#(+Array+[+Symbol+]) Other Item this instance is currently storiing
+	attr_reader :contents
+
+	#Initialiser. Please use Engine.define_item() instead
+	#
+	#id:: (+Symbol+) Key in Engine.items of the Item
+	#name:: (+String+) One-word name of the Item
+	#desc:: A long description of the Item printed when the player uses
+	#       "look at item"
+	#fixed:: (+Boolean+) If set to +false+ the Item can not be taken
+	#storage:: (+Integer+) The number of other Items this instance can hold
 	def initialize(id, name, desc, fixed, storage)
 		@id = id
 		@name = name
@@ -27,16 +50,52 @@ class Item < Entity
 	end
 
 	rtype [] => Boolean
+	#(+Boolean+)
+	#
+	#Executed when the Item is picked up. This function can be redefined
+	#on a per-instance basis using on_take(&block). If this returns false
+	#take will fail
 	def take_event
+		puts "Taken"
 		return true
 	end
 
 	rtype [] => Boolean
+	#(+Boolean+)
+	#
+	#Executed when the Item is picked up. This function can be redefined
+	#on a per-instance basis using on_drop(&block). If this returns false
+	#drop will fail.
 	def drop_event
+		puts "Dropped"
 		return true
 	end
 
+	rtype [Symbol] => Boolean
+	#(+Boolean+)
+	#
+	#Executed when another Item is placed inside this instance. This
+	#function can be redefined on a per-instance basis using on_add(&block).
+	#If this return false add_item will fail
+	#
+	#item:: (+Symbol+) Key in Engine.items of the item being added
+	def put_content_event(item)
+		return true
+	end
+
+	rtype [Symbol] => Boolean
+	#(+Boolean+)
+	#
+	#Executed an Item inside this instance of Item is removed by the player.
+	#If this returns false "take X from Y" will fail.
+	#
+	#item:: (+Symbol+) Key in Engine.items of the item being taken
+	def take_content_event(item)
+		puts "Taken"
+	end
+
 	rtype [] => nil
+	#Prints the description and the names of the contents if applicable
 	def look
 		puts @desc
 
@@ -54,12 +113,20 @@ class Item < Entity
 	end
 
 	rtype [Symbol] => Boolean
+	#(+Boolean+)
+	#
+	#Returns +true+ if this item contains another represented by the symbol
+	#item
 	def contains_item?(item)
 		return @contents.include?(item) if @storage > 0
-		return false
 	end
 
 	rtype [Symbol] => nil
+	#Stores another Item represented by the Symbol item and stores it
+	#within this Item if:
+	# * storage > 0
+	# * contents.size < 0
+	# * insert_event() returns true
 	def add_item(item)
 		if @storage == 0
 			raise GameError.new "#{@id} is not a container"
@@ -74,6 +141,11 @@ class Item < Entity
 	end
 
 	rtype [Symbol] => nil
+	#Removes an Item contained within this instance
+	#*NOTE* This does not place the Item in the player's inventory
+	#
+	#item:: (+Symbol+) Key in Engine.items of the Item being placed in this
+	#       instance of Item
 	def del_item(item)
 		#Skip if already contained
 		if contains_item?(item)
@@ -84,16 +156,46 @@ class Item < Entity
 	end
 
 	rtype [Proc] => nil
+	#Redefines Item::take_event for this specific instance
+	#
+	#&block:: (+Proc+ => +Boolean+) The new version of Item.take_event for
+	#         this specific instance *NOTE* Must return a +Boolean+
 	def on_take(&block)
 		self.define_singleton_method(:take_event, &block)
 		return nil
 	end
 
 	rtype [Proc] => nil
+	#Redefines Item::drop_event for this specific instance
+	#
+	#&block:: (+Proc+ => +Boolean+) The new version of Item.drop_event for
+	#         this specific instance *NOTE* Must return a +Boolean+
 	def on_drop(&block)
 		self.define_singleton_method(:drop_event, &block)
 		return nil
 	end
+
+	rtype [Proc] => nil
+	#Redefines Item::put_content_event for this specific instance
+	#
+	#&block:: (+Proc+ => +Boolean+) The new version of
+	#         Item.put_content_event for this specific instance.
+	#         *NOTE* Must return a +Boolean+
+	def on_put_content(&block)
+		self.define_singleton_method(:put_content_event, &block)
+		return nil
+	end
+
+	rtype [Proc] => nil
+	#Redefines Item::take_content_event for this specific instance
+	#
+	#&block:: (+Proc+ => +Boolean+) The new version of
+	#         Item.take_content_event for this specific instance.
+	#         *NOTE* Must return a +Boolean+
+	def on_put_content(&block)
+		self.define_singleton_method(:put_content_event, &block)
+		return nil
+	end
 end
 
 end

data/lib/twisty/room.rb

@@ -11,96 +11,149 @@ require_relative 'entity.rb'
 
 require 'rtype'
 
+#Author:: Ryan McCoskrie (mailto:work@ryanmccoskrie.me)
+#Copyright:: Copyright (c) 2017 - 2018 RyanMcCoskrie
+#License:: MIT public license
+
 module Twisty
 
-	class Room < Entity
-		attr_reader :name, :desc, :doors
-		attr_accessor :items
-
-		rtype [Symbol, String, String] => Array
-		def initialize(id, name, desc)
-			@id = id
-			@name = name
-			@desc = desc
-			@doors = {}
-			@items = []
-		end
+#This class models the locations within the game.
+class Room < Entity
+	#(+String+) Short name shown in the prompt
+	attr_reader :name
+	#(+String+) Description printed when the player types "look"
+	attr_reader :desc
+	#(+Hash+{+String+ => +Symbol+}) Names and keys in Engine.rooms of the
+	#locations the player can move from
+	attr_reader :doors
+	#(+Array+[+String+]) Items in the room. Does not include Items stored
+	#inside other Items
+	attr_accessor :items
+
+	rtype [Symbol, String, String] => Array
+	#Initializer. Please use Twisty::Engine::define_room() instead.
+	#
+	#id:: (+Symbol+) that represents the Room in Engine.rooms()
+	#name:: (+String+) Name shown to the player in the prompt
+	#desc:: (+String+) Long description shown when the player types "look"
+	def initialize(id, name, desc)
+		@id = id
+		@name = name
+		@desc = desc
+		@doors = {}
+		@items = []
+	end
 
-		rtype [] => Boolean
-		def enter_event
-			return true
-		end
+	rtype [] => Boolean
+	#(+Boolean+)
+	#
+	#Executed when the player attempts to enter the Room. This can be
+	#redefined on a per-instance basis using Room.on_enter(&block). If this
+	#returns +false+ the player will be blocked from entering
+	def enter_event
+		return true
+	end
 
-		rtype [] => Boolean
-		def exit_event
-			return true
-		end
+	rtype [] => Boolean
+	#(+Boolean+)
+	#
+	#Executed when the player attempts to exit the Room. This can be
+	#redefined on a per-instance basis using on_exit(&block). If this
+	#returns +false+ the player will be blocked from exiting
+	def exit_event
+		return true
+	end
 
-		rtype [Symbol, String] => nil
-		def add_door(to, name)
-			if name.split().length != 1
-				raise GameError.new "Door name must be one word"
-			elsif @doors.has_key? name
-				raise GameError.new "Door with name #{name} already exist in #{@id}"
-			else
-				@doors[to] = name
-			end
-
-			return nil
+	rtype [Symbol, String] => nil
+	#Adds an exit from this room to another
+	#*NOTE* For most purposes Engine.add_door() would be more convinient
+	#*NOTE* The "door" only works in one direction and that the exit is
+	#referred to by the String name, not the name of the other Room.
+	#
+	#to:: (+Symbol+) Key in Engine.rooms of the location the player will
+	#     be moved to if "walk" is sucessfully executed
+	#name:: (+String+) Name displayed by "look" and typed as part of "walk".
+	#       This can be a word such as "East" instead of the destination's
+	#       actual name
+	def add_door(to, name)
+		if name.split().length != 1
+			raise GameError.new "Door name must be one word"
+		elsif @doors.has_key? name
+			raise GameError.new "Door with name #{name} already exist in #{@id}"
+		else
+			@doors[to] = name
 		end
 
-		rtype [Symbol] => Array.of(Symbol)
-		def add_item(id)
-			if @items.include? id
-				raise GameError.new "Duplicate item in room #{@id}"
-			else
-				@items << id
-			end
-		end
+		return nil
+	end
 
-		rtype [Proc] => nil
-		def on_enter(&block)
-			self.define_singleton_method(:enter_event, &block)
-			return nil
+	rtype [Symbol] => Array.of(Symbol)
+	#Places an Item within a the Room. Note that is must first be defined
+	#with Twisty::Engine::define_item()
+	#
+	#id:: (+Symbol+) Key in Engine.items for the Item that will be added to
+	#     the Room
+	def add_item(id)
+		if @items.include? id
+			raise GameError.new "Duplicate item in room #{@id}"
+		else
+			@items << id
 		end
+	end
 
-		rtype [Proc] => nil
-		def on_exit(&block)
-			self.define_singleton_method(:exit_event, &block)
-			return nil
-		end
+	rtype [Proc] => nil
+	#Used to redefine enter_event
+	#
+	#&block:: (+Proc+ => +Boolean+) Code executed on entering the Room.
+	#         *NOTE* If this returns +false+ the player "walk" will fail
+	def on_enter(&block)
+		self.define_singleton_method(:enter_event, &block)
+		return nil
+	end
 
-		rtype [] => nil
-		def look
-			puts @desc
+	rtype [Proc] => nil
+	#Used to redefine exit_event
+	#
+	#&block:: (+Proc+ => +Boolean+) Code executed on exiting the Room.
+	#         *NOTE* If this returns +false+ the player "walk" will fail
+	def on_exit(&block)
+		self.define_singleton_method(:exit_event, &block)
+		return nil
+	end
 
-			if @items.length == 0
-				puts "Nothing is located here"
-			elsif @items.length == 1
-				puts
+	rtype [] => nil
+	#Prints the description of the Room and its contents / exits if
+	#applicable.
+	def look
+		puts @desc
 
-				puts "Located here is:"
-				puts engine.items[@items[0]].name
-			else
-				puts
+		if @items.length == 0
+			puts "Nothing is located here"
+		elsif @items.length == 1
+			puts
 
-				puts "Located here are:"
-				@items.each{ |id| puts engine.items[id].name }
-			end
+			puts "Located here is:"
+			puts engine.items[@items[0]].name
+		else
+			puts
 
-				puts
+			puts "Located here are:"
+			@items.each{ |id| puts engine.items[id].name }
+		end
 
-			if doors.length == 0
-				puts "There is no exit"
-			elsif doors.length == 1
-				puts "The only exit is: #{@doors.values[0]}"
-			else
-				puts "The exits are:"
-				@doors.values.each{|name| puts name}
-			end
+			puts
 
-			return nil
+		if doors.length == 0
+			puts "There is no exit"
+		elsif doors.length == 1
+			puts "The only exit is: #{@doors.values[0]}"
+		else
+			puts "The exits are:"
+			@doors.values.each{|name| puts name}
 		end
+
+		return nil
 	end
+end
 
 end

data/lib/twisty.rb

@@ -21,7 +21,7 @@ Engine.instance.define_command(
 	/^help$/,
 	"help",
 	"Write out the list of commands you are reading now") do |x|
-		@commands.values.each do |command|
+		engine.commands.values.each do |command|
 			puts "#{command.help1}:"
 			puts "#{command.help2}"
 			puts
@@ -30,67 +30,67 @@ Engine.instance.define_command(
 Engine.instance.define_command(
 	/^look$/,
 	"look",
-	"Look at the current room") {|x| current_room.look()}
+	"Look at the current room") {|x| engine.current_room.look()}
 
 Engine.instance.define_command(
 	/^look at \w+$/,
 	"look at object",
 	"Look at a specific object") do |tokens|
 		found = false
-		current_items.each do |id|
-			if @items[id].name.downcase == tokens[2]
-				@items[id].look
+		engine.current_items.each do |id|
+			if engine.items[id].name.downcase == tokens[2]
+				engine.items[id].look
 				found = true
 				break
 			end
 		end
 
 		#Error condidtion
-		raise PlayError.new "I see no #{tokens[2]}" unless found
+		raise PlayError.new "I see no #{tokens[2]}" if not found
 	end
 Engine.instance.define_command(
 	/^inventory$/,
 	"inventory",
 	"Get a list of things you are carrying") do |x|
-		if @inventory.size == 0
+		if engine.inventory.size == 0
 			puts "You are currently carrying nothing"
 		else
 			puts "You are currently carring: "
-			@inventory.each{|id| puts @items[id].name}
+			engine.inventory.each{|id| puts engine.items[id].name}
 		end
 	end
 Engine.instance.define_command(
 	/^take \w+$/,
 	"take object",
 	"Take an object and carry it in your inventory") do |tokens|
-		take_item_by_name(tokens[1])
+		engine.take_item_by_name(tokens[1])
 	end
 Engine.instance.define_command(
 	/^take \w+ from \w+$/,
 	"take object from container",
 	"Take an object out of a container and carry it your inventory") do |tokens|
-		take_from_by_name_name(tokens[1], tokens[3])
+		engine.take_from_by_name_name(tokens[1], tokens[3])
 	end
 Engine.instance.define_command(
 	/^drop \w+$/,
 	"drop object",
 	"Remove an object from your inventory and leave it in the room") do |tokens|
-		drop_item_by_name(tokens[1])
+		engine.drop_item_by_name(tokens[1])
 	end
 Engine.instance.define_command(
 	/^put \w+ in \w+$/,
 	"put item in container",
 	"Remove an object from your inventory and leave it in a container") do |tokens|
-		put_item_by_name_name(tokens[1], tokens[3])
+		engine.put_item_by_name_name(tokens[1], tokens[3])
 	end
 Engine.instance.define_command(
 	/^walk \w+$/,
 	"walk exit",
 	"Walk out of the room through an exit") do |tokens|
 		found = false
-		current_doors.each_pair do |to, name|
+		engine.current_doors.each_pair do |to, name|
 			if name.downcase == tokens[1]
-				goto to
+				engine.goto to
 				found = true
 				break
 			end
@@ -102,5 +102,5 @@ Engine.instance.define_command(
 Engine.instance.define_command(
 	/^quit$/,
 	"quit",
-	"Stop playing the game") {|x| @playing = false}
+	"Stop playing the game") {|x| engine.end_loop()}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twisty
 version: !ruby/object:Gem::Version
-  version: 0.0.2b
+  version: 0.0.3
 platform: ruby
 authors:
 - Ryan McCoskrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2018-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rtype-native
@@ -37,7 +37,7 @@ files:
 - lib/twisty/error.rb
 - lib/twisty/item.rb
 - lib/twisty/room.rb
-homepage: http://rubygems.org/gems/twisty
+homepage: http://gitlab.com/RyanMcCoskrie/Twisty
 licenses:
 - MIT
 metadata: {}
@@ -52,12 +52,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Twisty