#!/usr/bin/env python
# encoding: iso-8859-15
#
#Minë. Mundo Interactivo-Narrativo en Español [Tierra-Media]
#Copyright (C) 2002  Pablo Ruiz Múzquiz
#
#
#This program is free software; you can redistribute it and/or modify
#it under the terms of the GNU General Public License as published by
#the Free Software Foundation; either version 2 of the License, or
#(at your option) any later version.
#
#This program is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#GNU General Public License for more details.
#
#You should have received a copy of the GNU General Public License
#along with this program; if not, write to the Free Software
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#

#
#Fichero: Controlador.py

"""Interfaz Controlador."""


class Controlador(object):
    """Interfaz que debe implementar cualquier entidad que controla a un personaje.
    
    Contiene los mensajes de respuesta a los sucesos que producen los personajes.
    
    En la mayoría de los lenguajes orientados a objetos hay que crear una clase o
    un interfaz para esto. En Python, debido a ser dinámicamente tipado, esta
    clase en realidad es totalmente innecesaria. La pongo sólo como documentación.
    
    Todos los métodos tienen que estar redefinidos en subclases.
    """
                        
                        
    def entra_personaje(self, personaje):
        """Metodo llamado cuando otro personaje entra en la misma sala.
        
        personaje -- el personaje que entra.
        """
        pass
                        
                        
    def sale_personaje(self, personaje, nombre_sala_destino):
        """Metodo llamado cuando otro personaje sale de la misma sala.
        
        personaje -- el personaje que sale.
        nombre_sala_destino -- el nombre de la sala a donde va
        """
        pass
                        

    def habla_personaje(self, personaje, mensaje):
        """Metodo llamado cuando otro personaje dice algo en la sala.
        
        personaje -- el personaje que habla.
        mensaje -- lo que dice.
        """
        pass


    def susurra_personaje(self, personaje, mensaje):
        """Metodo llamado cuando otro personaje dice algo sólo para éste.
        
        personaje -- el personaje que susurra.
        mensaje -- lo que dice.
        """
	pass    
    
                        
    def grita_personaje(self, personaje, mensaje):
        """Metodo llamado cuando otro personaje dice algo que oyen *todos*
	los personajes de Minë (esto habría que cambiarlo porque es OOC).
        
        personaje -- el personaje que grita.
        mensaje -- lo que dice.
        """
        pass
                        
                        
    def actua_personaje(self, personaje, accion):
        """Metodo llamado cuando otro personaje en la sala describe lo
	que hace de forma novelada.
        
        personaje -- el personaje que actua.
        accion -- lo que hace (el texto está expresado para colocarle
	          el nombre del personaje al principio, por ejemplo
		  "coge una lampara" -> "Hirunatan coge una lampara").
        """
        pass


    def actua_individual_personaje(self, personaje, accion):
        """Metodo llamado cuando otro personaje describe lo que hace
	de forma que sólo lo percibe éste.
        
        personaje -- el personaje que actúa.
        accion -- lo que hace (el texto está expresado para colocarle
	          el personaje al principio, y está en segunda persona,
		  por ejemplo "te da una espada" -> "Aranarth te da una
		  espada").
        """
	pass    


    def actua_uno_mismo(self, accion):
	"""Metodo llamado cuando el personaje se informa a si mismo (a su
	controlador, en realidad) de algo que hace.

	Normalmente esto sucede de forma asíncrona, es decir, no como
	respuesta directa a una acción del jugador, sino indirectamente.

	accion -- lo que hace (el texto va en segunda persona, y se
	          mostrará tal cual en pantalla, por ejemplo "No puedes
		  seguir a Hirunatan porque la sala está llena").
	"""
	pass
                        
                        
    def actua_global_personaje(self, personaje, accion):
        """Metodo llamado cuando otro personaje describe de forma novelada
	algo que hace y que ven *todos* los personajes de Minë.
        
        personaje -- el personaje que actua.
        accion -- lo que hace (el texto está expresado para colocarle
	          el nombre del personaje al principio, por ejemplo
		  "ha entrado en Minë" -> "Hirunatan ha entrado en Minë").
        """
        pass


    def suceso_entorno(self, suceso):
	"""Método llamado cuando ocurre un fenómeno ambiental, independiente
	de ningún personaje concreto.
	
	personaje -- el personaje que actúa.
	suceso -- lo que ocurre (el texto está expresado de forma impersonal,
	          y se mostrará tal cual en pantalla, por ejemplo "De pronto
		  se hace un silencio sepulcral en la sala").
	"""
	pass
        
        
    def ataca_personaje(self, personaje, result):
        """Metodo llamado cuando otro personaje inicia un ataque a este.
        
        personaje -- el personaje que ha atacado.
        result -- el resultado del combate (Personaje.ATAQUE_EXITO, etc.)
        """
        pass


    def movimiento_automatico(self):
	"""Metodo llamado cuando el personaje se ha movido automaticamente
	a otra sala, por estar siguiendo a otro personaje.
	"""
	pass


    def paga_personaje(self, personaje, monedas):
	"""Metodo llamado cuando otro personaje paga dinero a este.

	personaje -- el personaje que ha pagado
	monedas -- el numero de monedas que nos ha dado
	"""
	pass



# Código para pruebas unitarias del módulo.

if (__name__ == '__main__'):
    print "No hay código para pruebas unitarias del módulo, ya que es un interfaz"
    print "y no tiene código."
