root/trunk/lib/fm/animatedobject.rb

#!/usr/bin/ruby

require 'fm'
require 'fm/mixins'
require 'fm/exceptions'
require 'fm/composedobject'
require 'fm/perception'


# 
# The FaerieMUD::AnimatedObject class, a derivative of FaerieMUD::ComposedObject. 
# AnimatedObjects are objects which can be controlled by a Spirit, and have Perception.
# 
# == Subversion ID
# 
# $Id$
# 
# == Authors
# 
# * Michael Granger <ged@FaerieMUD.org>
# 
# :include: LICENSE
#
#---
#
# Please see the file LICENSE for licensing details.
#
class FaerieMUD::AnimatedObject < FaerieMUD::ComposedObject
        contributors :ged

        include FaerieMUD::AccessorFunctions

        # 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
        #############################################################

        ### Create a new FaerieMUD::AnimatedObject.
        def initialize( args={} )
                @affinities = {}
                @description = nil
                @name = nil
                @controller = nil
                @perception = FaerieMUD::Perception::new( self )

                super
        end


        ### Copy initializer -- initialize a cloned or duped AnimatedObject with
        ### cloned values from the +original+.
        def initialize_copy( original )
                super

                @affinities = original.affinities.clone
                @description = "%s (Cloned)" % original.description
                @name = "Clone of %s" % original.name
                @controller = nil
        end


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

        # The Spirit objects for which this AnimatedObject has an affinity. The
        # Presence necessary to animate the object for which a Spirit has an
        # affinity is greatly reduced.
        attr_accessor :affinities

        # A short (25 characters or so) description of the object.
        attr_accessor :description

        # A one-word unique name for the object, used when identifying it for
        # animation.
        attr_accessor :name

        # The controlling FaerieMUD::Spirit object (might also be a
        # Bifurcation).
        attr_locked_accessor :controller


        ### Provide a description of the given +events+ to the connected
        ### controller/s. More-specific subclasses should probably override this
        ### method to provide vetting, contextualization, distortion, and grouping
        ### of incoming events. This implementation just writes a sentence per event
        ### to the controlling Spirit.
        def describe_event( event )
                @controller.output( event.as_sentence )
        end

end # class FaerieMUD::AnimatedObject