ifmapper 1.0.0 → 1.0.6

data/lib/IFMapper/Room.rb

@@ -1,151 +1,153 @@
-
-#
-# Class used to represent a Room or Location in a Map.
-#
-class Room
-  attr_accessor  :name      # Name of room
-  attr_accessor  :objects   # Objects found in room
-  attr_accessor  :tasks     # Tasks that need to be performed in room
-  attr_reader    :exits     # An array of 8 possible exits in room
-  attr_accessor  :darkness  # Is room in darkness?
-  attr_accessor  :x, :y     # Room location in grid
-  attr_accessor  :desc      # Room description
-
-  DIR_TO_VECTOR = { 
-    0 => [  0, -1 ],
-    1 => [  1, -1 ],
-    2 => [  1,  0 ],
-    3 => [  1,  1 ],
-    4 => [  0,  1 ],
-    5 => [ -1,  1 ],
-    6 => [ -1,  0 ],
-    7 => [ -1, -1 ]
-  }
-
-  def marshal_load(vars)
-    @name     = vars.shift
-    @objects  = vars.shift
-    @tasks    = vars.shift
-    @exits    = vars.shift
-    @darkness = vars.shift
-    @x        = vars.shift
-    @y        = vars.shift
-    if not vars.empty? and vars[0].kind_of?(String)
-      @desc     = vars.shift
-      @desc.gsub!(/(\w)\s*\n/, '\1 ')
-      @desc.sub!(/\n+$/, '')
-      @desc.strip!
-    end
-  end
-
-  def marshal_dump
-    [ @name, @objects, @tasks, @exits, @darkness, @x, @y, @desc ]
-  end
-
-  def [](dir)
-    return @exits[dir]
-  end
-
-  def []=(dir, connection)
-    @exits[dir] = connection
-  end
-
-  #
-  # Return the number of doors present in room
-  #
-  def num_doors
-    num = 0
-    @exits.each { |e|
-      next if not e
-      num += 1 if e.door?
-    }
-    return num
-  end
-
-  #
-  # Return the number of exits present in room
-  #
-  def num_exits
-    return @exits.nitems
-  end
-
-  #
-  # Return a direction from the vector of the exit that would take
-  # us to the 'b' room more cleanly.
-  #
-  def self.vector_to_dir(dx, dy)
-    if dx == 0
-      return 4 if dy > 0
-      return 0 if dy < 0
-      raise "vector_to_dir: dx == 0 and dy == 0"
-    elsif dx > 0
-      return 1 if dy < 0
-      return 2 if dy == 0
-      return 3
-    else
-      return 7 if dy < 0
-      return 6 if dy == 0
-      return 5
-    end
-  end
-
-  def vector_to_dir(dx, dy)
-    return Room::vector_to_dir( dx, dy )
-  end
-
-  #
-  # Given an 'adjacent' room, return the most direct exit from this
-  # room to room b.
-  #
-  def exit_to(b)
-    dx = (b.x - @x)
-    dy = (b.y - @y)
-    return vector_to_dir(dx, dy)
-  end
-  
-  # Check if two rooms are next to each other.  If so,
-  # return the exit that would take us from this room to the other.
-  # Otherwise, return nil
-  def next_to?(b)
-    if not b.kind_of?(Room)
-      raise "next_to?(b): #{b} is not a room."
-    end
-    if self == b
-      raise "next_to? comparing same room #{self}"
-    end
-    if b.x == @x and b.y == @y
-      raise "#{self} and #{b} in same location."
-    end
-    dx = (b.x - @x)
-    dy = (b.y - @y)
-    return nil if dx.abs > 1 or dy.abs > 1
-    return vector_to_dir(dx, dy)
-  end
-
-  #
-  # Copy a room to another
-  #
-  def copy(b)
-    @name     = b.name
-    @objects  = b.objects
-    @tasks    = b.tasks
-    @darkness = b.darkness
-    @desc     = b.desc
-  end
-
-
-  def initialize(x, y, name = 'Room')
-    @exits    = Array.new( DIRECTIONS.size )
-    @darkness = false
-    @name     = name
-    @x = x
-    @y = y
-
-    @objects  = ''
-    @tasks = ''
-  end
-
-  def to_s
-    "\"#{@name}\""
-  end
-end
+
+#
+# Class used to represent a Room or Location in a Map.
+#
+class Room
+  attr_accessor  :name      # Name of room
+  attr_accessor  :objects   # Objects found in room
+  attr_accessor  :tasks     # Tasks that need to be performed in room
+  attr_reader    :exits     # An array of 8 possible exits in room
+  attr_accessor  :darkness  # Isxxxxxxxxxx room in darkness?
+  attr_accessor  :x, :y     # Room location in grid
+  attr_accessor  :desc      # Room description
+
+  DIR_TO_VECTOR = { 
+    0 => [  0, -1 ],
+    1 => [  1, -1 ],
+    2 => [  1,  0 ],
+    3 => [  1,  1 ],
+    4 => [  0,  1 ],
+    5 => [ -1,  1 ],
+    6 => [ -1,  0 ],
+    7 => [ -1, -1 ]
+  }
+
+  def marshal_load(vars)
+    @name     = vars.shift
+    @objects  = vars.shift
+    @tasks    = vars.shift
+    @exits    = vars.shift
+    @darkness = vars.shift
+    @x        = vars.shift
+    @y        = vars.shift
+    @desc     = nil
+    if not vars.empty? and vars[0].kind_of?(String)
+      @desc     = vars.shift
+      @desc.gsub!(/(\w)\s*\n/, '\1 ')
+      @desc.sub!(/\n+$/, '')
+      @desc.strip!
+    end
+  end
+
+  def marshal_dump
+    [ @name, @objects, @tasks, @exits, @darkness, @x, @y, @desc ]
+  end
+
+  def [](dir)
+    return @exits[dir]
+  end
+
+  def []=(dir, connection)
+    @exits[dir] = connection
+  end
+
+  #
+  # Return the number of doors present in room
+  #
+  def num_doors
+    num = 0
+    @exits.each { |e|
+      next if not e
+      num += 1 if e.door?
+    }
+    return num
+  end
+
+  #
+  # Return the number of exits present in room
+  #
+  def num_exits
+    return @exits.nitems
+  end
+
+  #
+  # Return a direction from the vector of the exit that would take
+  # us to the 'b' room more cleanly.
+  #
+  def self.vector_to_dir(dx, dy)
+    if dx == 0
+      return 4 if dy > 0
+      return 0 if dy < 0
+      raise "vector_to_dir: dx == 0 and dy == 0"
+    elsif dx > 0
+      return 1 if dy < 0
+      return 2 if dy == 0
+      return 3
+    else
+      return 7 if dy < 0
+      return 6 if dy == 0
+      return 5
+    end
+  end
+
+  def vector_to_dir(dx, dy)
+    return Room::vector_to_dir( dx, dy )
+  end
+
+  #
+  # Given an 'adjacent' room, return the most direct exit from this
+  # room to room b.
+  #
+  def exit_to(b)
+    dx = (b.x - @x)
+    dy = (b.y - @y)
+    return vector_to_dir(dx, dy)
+  end
+  
+  # Check if two rooms are next to each other.  If so,
+  # return the exit that would take us from this room to the other.
+  # Otherwise, return nil
+  def next_to?(b)
+    if not b.kind_of?(Room)
+      raise "next_to?(b): #{b} is not a room."
+    end
+    if self == b
+      raise "next_to? comparing same room #{self}"
+    end
+    if b.x == @x and b.y == @y
+      raise "#{self} and #{b} in same location."
+    end
+    dx = (b.x - @x)
+    dy = (b.y - @y)
+    return nil if dx.abs > 1 or dy.abs > 1
+    return vector_to_dir(dx, dy)
+  end
+
+  #
+  # Copy a room to another
+  #
+  def copy(b)
+    @name     = b.name
+    @objects  = b.objects
+    @tasks    = b.tasks
+    @darkness = b.darkness
+    @desc     = b.desc
+  end
+
+
+  def initialize(x, y, name = 'Room')
+    @exits    = Array.new( DIRECTIONS.size )
+    @darkness = false
+    @name     = name
+    @x = x
+    @y = y
+
+    @desc     = nil
+    @objects  = ''
+    @tasks = ''
+  end
+
+  def to_s
+    "\"#{@name}\""
+  end
+end

data/lib/IFMapper/Section.rb

@@ -1,234 +1,234 @@
-
-
-require 'IFMapper/Connection'
-require 'IFMapper/Room'
-
-class Section
-  attr_accessor :rooms
-  attr_accessor :connections
-  attr_accessor :name
-
-  class ConnectionError < StandardError; end
-
-  def marshal_load(v)
-    @rooms       = v[0]
-    @connections = v[1]
-    @name        = v[2]
-  end
-
-  def marshal_dump
-    return [ @rooms, @connections, @name ]
-  end
-
-  #
-  # Return the number of rooms in width and height for this page
-  #
-  def rooms_width_height
-    minXY, maxXY = min_max_rooms
-    return [ 
-      maxXY[0] - minXY[0] + 1,
-      maxXY[1] - minXY[1] + 1
-    ]
-  end
-
-  #
-  # Return the min and max coordinates of all rooms in page
-  #
-  def min_max_rooms
-    return [[0, 0],[0, 0]] if @rooms.empty?
-    
-    minXY = [ @rooms[0].x, @rooms[0].y ]
-    maxXY = minXY.dup
-    @rooms.each { |r|
-      minXY[0] = r.x if r.x < minXY[0]
-      minXY[1] = r.y if r.y < minXY[1]
-      maxXY[0] = r.x if r.x > maxXY[0]
-      maxXY[1] = r.y if r.y > maxXY[1]
-    }
-    return [ minXY, maxXY ]
-  end
-
-  #
-  # Return true or false if map is free at location x,y
-  #
-  def free?(x,y)
-    @rooms.each { |r|
-      return false if r.x == x and r.y == y
-    }
-    return true
-  end
-
-  #
-  # Shift rooms in dx and dy direction from x,y position on.
-  #
-  def shift(x, y, dx, dy)
-    @rooms.each { |r|
-      ox = oy = 0
-      if (dx < 0 and r.x <= x) or
-	  (dx > 0 and r.x >= x)
-	ox = dx
-      end
-      if (dy < 0 and r.y <= y) or
-	  (dy > 0 and r.y >= y)
-	oy = dy
-      end
-      r.x += ox
-      r.y += oy
-    }
-  end
-
-
-  #
-  # Delete a connection from section
-  #
-  def delete_connection(c)
-    a = c.roomA
-    if a
-      e = a.exits.index(c)
-      a[e] = nil if e
-    end
-    b = c.roomB
-    if b
-      e = b.exits.rindex(c)
-      b[e] = nil if e
-    end
-    @connections.delete(c)
-  end
-
-  #
-  # Delete a connection at a certain index location
-  #
-  def delete_connection_at( idx )
-    c = @connections[idx]
-
-    a = c.roomA
-    if a
-      e = a.exits.index(c)
-      a[e] = nil if e
-    end
-    b = c.roomB
-    if b
-      e = b.exits.rindex(c)
-      b[e] = nil if e
-    end
-    @connections.delete_at(idx)
-  end
-
-  #
-  # Create a new connection among two rooms thru their exits
-  #
-  def new_connection( roomA, exitA, roomB, exitB = nil )
-
-    # Verify rooms exist in section (ie. don't allow links across
-    # sections)
-    if not @rooms.include?(roomA)
-      raise ConnectionError, "Room '#{roomA}' not in section #{self}"
-    end
-    if roomB and not @rooms.include?(roomB)
-      raise ConnectionError, "Room '#{roomB}' not in section #{self}"
-    end
-
-    c = Connection.new( roomA, roomB )
-    _new_connection( c, roomA, exitA, roomB, exitB )
-  end
-
-  #
-  # Delete a room at a certain index
-  #
-  def delete_room_at(idx)
-    r = @rooms[idx]
-    r.exits.each { |e|
-      next if not e
-      delete_connection(e)
-    }
-    @rooms.delete_at(idx)
-  end
-
-  #
-  # Delete a room, leaving its connections intact
-  #
-  def delete_room_only(r)
-    @rooms.delete(r)
-  end
-
-  #
-  # Delete a room and all of its connections
-  #
-  def delete_room(r)
-    r.exits.each { |e|
-      next if not e
-      delete_connection(e)
-    }
-    delete_room_only(r)
-  end
-
-  #
-  # Create a new room  (note: FXSection overrides this creating an
-  # FXRoom instead).
-  #
-  def new_room( x, y )
-    r = Room.new( x, y, 'New Location' )
-    return _new_room(r, x, y)
-  end
-
-  def initialize()
-    @rooms       = []
-    @connections = []
-    @name        = ''
-  end
-
-  protected
-
-  def _new_room( r, x, y )
-    @rooms.push(r)
-    return r
-  end
-
-  def _new_connection(c, roomA, exitA, roomB, exitB)
-    exitA = roomA.exit_to(roomB) if not exitA
-    if not exitA
-      err = <<"EOF"
-No exit given or guessed to connect: 
-      Room #{roomA} (#{roomA.x}, #{roomA.y})
-      Room #{roomB} (#{roomB.x}, #{roomB.y})
-EOF
-      raise ConnectionError, err
-    end
-
-    if roomA[exitA]
-      if not @connections.include?(roomA[exitA])
-	raise ConnectionError, "roomA exit #{exitA} for '#{roomA}' filled but not in section"
-      end
-      raise ConnectionError, "roomA exit #{exitA} for '#{roomA}' is filled" 
-    end
-
-    roomA[exitA] = c
-
-    if roomB and not exitB
-      dx, dy = Room::DIR_TO_VECTOR[exitA]
-      x = roomA.x + dx
-      y = roomA.y + dy
-      if roomB.x == x and roomB.y == y
-	exitB = (exitA + 4) % 8 
-      else
-	dx = x - roomB.x
-	dy = y - roomB.y
-	exitB = roomB.vector_to_dir(dx, dy)
-      end
-    end
-
-    if roomB and roomB[exitB] and roomB[exitB] != c
-      roomA[exitA] = nil
-      raise ConnectionError, "roomB exit #{exitB} for #{roomB} is filled with #{roomB[exitB]}" 
-    end
-    roomB[exitB] = c if roomB
-
-    @connections.push( c )
-    return c
-  end
-
-  def to_s
-    return @name
-  end
-
-end
+
+
+require 'IFMapper/Connection'
+require 'IFMapper/Room'
+
+class Section
+  attr_accessor :rooms
+  attr_accessor :connections
+  attr_accessor :name
+
+  class ConnectionError < StandardError; end
+
+  def marshal_load(v)
+    @rooms       = v[0]
+    @connections = v[1]
+    @name        = v[2]
+  end
+
+  def marshal_dump
+    return [ @rooms, @connections, @name ]
+  end
+
+  #
+  # Return the number of rooms in width and height for this page
+  #
+  def rooms_width_height
+    minXY, maxXY = min_max_rooms
+    return [ 
+      maxXY[0] - minXY[0] + 1,
+      maxXY[1] - minXY[1] + 1
+    ]
+  end
+
+  #
+  # Return the min and max coordinates of all rooms in page
+  #
+  def min_max_rooms
+    return [[0, 0],[0, 0]] if @rooms.empty?
+    
+    minXY = [ @rooms[0].x, @rooms[0].y ]
+    maxXY = minXY.dup
+    @rooms.each { |r|
+      minXY[0] = r.x if r.x < minXY[0]
+      minXY[1] = r.y if r.y < minXY[1]
+      maxXY[0] = r.x if r.x > maxXY[0]
+      maxXY[1] = r.y if r.y > maxXY[1]
+    }
+    return [ minXY, maxXY ]
+  end
+
+  #
+  # Return true or false if map is free at location x,y
+  #
+  def free?(x,y)
+    @rooms.each { |r|
+      return false if r.x == x and r.y == y
+    }
+    return true
+  end
+
+  #
+  # Shift rooms in dx and dy direction from x,y position on.
+  #
+  def shift(x, y, dx, dy)
+    @rooms.each { |r|
+      ox = oy = 0
+      if (dx < 0 and r.x <= x) or
+	  (dx > 0 and r.x >= x)
+	ox = dx
+      end
+      if (dy < 0 and r.y <= y) or
+	  (dy > 0 and r.y >= y)
+	oy = dy
+      end
+      r.x += ox
+      r.y += oy
+    }
+  end
+
+
+  #
+  # Delete a connection from section
+  #
+  def delete_connection(c)
+    a = c.roomA
+    if a
+      e = a.exits.index(c)
+      a[e] = nil if e
+    end
+    b = c.roomB
+    if b
+      e = b.exits.rindex(c)
+      b[e] = nil if e
+    end
+    @connections.delete(c)
+  end
+
+  #
+  # Delete a connection at a certain index location
+  #
+  def delete_connection_at( idx )
+    c = @connections[idx]
+
+    a = c.roomA
+    if a
+      e = a.exits.index(c)
+      a[e] = nil if e
+    end
+    b = c.roomB
+    if b
+      e = b.exits.rindex(c)
+      b[e] = nil if e
+    end
+    @connections.delete_at(idx)
+  end
+
+  #
+  # Create a new connection among two rooms thru their exits
+  #
+  def new_connection( roomA, exitA, roomB, exitB = nil )
+
+    # Verify rooms exist in section (ie. don't allow links across
+    # sections)
+    if not @rooms.include?(roomA)
+      raise ConnectionError, "Room '#{roomA}' not in section #{self}"
+    end
+    if roomB and not @rooms.include?(roomB)
+      raise ConnectionError, "Room '#{roomB}' not in section #{self}"
+    end
+
+    c = Connection.new( roomA, roomB )
+    _new_connection( c, roomA, exitA, roomB, exitB )
+  end
+
+  #
+  # Delete a room at a certain index
+  #
+  def delete_room_at(idx)
+    r = @rooms[idx]
+    r.exits.each { |e|
+      next if not e
+      delete_connection(e)
+    }
+    @rooms.delete_at(idx)
+  end
+
+  #
+  # Delete a room, leaving its connections intact
+  #
+  def delete_room_only(r)
+    @rooms.delete(r)
+  end
+
+  #
+  # Delete a room and all of its connections
+  #
+  def delete_room(r)
+    r.exits.each { |e|
+      next if not e
+      delete_connection(e)
+    }
+    delete_room_only(r)
+  end
+
+  #
+  # Create a new room  (note: FXSection overrides this creating an
+  # FXRoom instead).
+  #
+  def new_room( x, y )
+    r = Room.new( x, y, 'New Location' )
+    return _new_room(r, x, y)
+  end
+
+  def initialize()
+    @rooms       = []
+    @connections = []
+    @name        = ''
+  end
+
+  protected
+
+  def _new_room( r, x, y )
+    @rooms.push(r)
+    return r
+  end
+
+  def _new_connection(c, roomA, exitA, roomB, exitB)
+    exitA = roomA.exit_to(roomB) if not exitA
+    if not exitA
+      err = <<"EOF"
+No exit given or guessed to connect: 
+      Room #{roomA} (#{roomA.x}, #{roomA.y})
+      Room #{roomB} (#{roomB.x}, #{roomB.y})
+EOF
+      raise ConnectionError, err
+    end
+
+    if roomA[exitA]
+      if not @connections.include?(roomA[exitA])
+	raise ConnectionError, "roomA exit #{exitA} for '#{roomA}' filled but not in section"
+      end
+      raise ConnectionError, "roomA exit #{exitA} for '#{roomA}' is filled" 
+    end
+
+    roomA[exitA] = c
+
+    if roomB and not exitB
+      dx, dy = Room::DIR_TO_VECTOR[exitA]
+      x = roomA.x + dx
+      y = roomA.y + dy
+      if roomB.x == x and roomB.y == y
+	exitB = (exitA + 4) % 8 
+      else
+	dx = x - roomB.x
+	dy = y - roomB.y
+	exitB = roomB.vector_to_dir(dx, dy)
+      end
+    end
+
+    if roomB and roomB[exitB] and roomB[exitB] != c
+      roomA[exitA] = nil
+      raise ConnectionError, "roomB exit #{exitB} for #{roomB} is filled with #{roomB[exitB]}" 
+    end
+    roomB[exitB] = c if roomB
+
+    @connections.push( c )
+    return c
+  end
+
+  def to_s
+    return @name
+  end
+
+end