root/trunk/lib/fm/area.rb

#!/usr/bin/ruby

require 'fm'
require 'fm/mixins'
require 'fm/exceptions'
require 'fm/locus'
require 'fm/events/all'

# 
# The FaerieMUD::Area class, a derivative of FaerieMUD::Locus. Instances of
# this class describe a more-or-less contiguous area of the FaerieMUD game
# world. It adds a local cartesian coordinate system and event propagation
# reflection to the functionality inherited from the Locus class.
# 
# == Subversion ID
# 
# $Id$
# 
# == Authors
# 
# * Michael Granger <ged@FaerieMUD.org>
# 
# :include: LICENSE
#
#---
#
# Please see the file LICENSE for licensing details.
#
class FaerieMUD::Area < FaerieMUD::Locus
        contributors :ged

        # SVN Revision
        SVNRev = %q$Rev$

        # SVN Id
        SVNId = %q$Id$



        #############################################################
        ###     I N S T A N C E   M E T H O D S
        #############################################################

        ######
        public
        ######

        # :TODO: Override add_contents(), to test for location and apply coordinates to
        # the object.
        
        ### Override #disperse_events to reflect events back into the contents.
        def disperse_events( *events )
                # :TODO: Avoid event loops?
                self.immerse_events( *events )
                super
        end


end # class FaerieMUD::Area