parpg-core: src/parpg/dialogueprocessor.py annotate

annotate src/parpg/dialogueprocessor.py @ 71:2168d761d865

Backed out changeset: ee350343b69b Didn't work as expected

author	KarstenBock@gmx.net
date	Tue, 06 Sep 2011 18:14:42 +0200
parents	1fd2201f5c36
children

rev	line source
0 1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	1 # This file is part of PARPG.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	2 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	3 # PARPG is free software: you can redistribute it and/or modify
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	4 # it under the terms of the GNU General Public License as published by
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	5 # the Free Software Foundation, either version 3 of the License, or
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	6 # (at your option) any later version.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	7 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	8 # PARPG is distributed in the hope that it will be useful,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	11 # GNU General Public License for more details.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	12 #
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	13 # You should have received a copy of the GNU General Public License
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	14 # along with PARPG. If not, see <http://www.gnu.org/licenses/>.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	15 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	16 Provides the core interface to the dialogue subsystem used to process player
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	17 L{Dialogues<Dialogue>} with NPCs.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	18 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	19 import logging
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	20
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	21 from parpg.common.utils import dedent_chomp
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	22
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	23 if (__debug__):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	24 from collections import Sequence, MutableMapping
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	25 from parpg.dialogue import Dialogue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	26
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	27 logger = logging.getLogger('dialogueprocessor')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	29 class DialogueProcessor(object):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	30 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	31 Primary interface to the dialogue subsystem used to initiate and process a
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	32 L{Dialogue} with an NPC.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	34 To begin a dialogue with an NPC a L{DialogueProcessor} must first be
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	35 instantiated with the dialogue data to process and a dictionary of Python
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	36 objects defining the game state for testing of response conditionals. The
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	37 L{initiateDialogue} must be called to initialized the L{DialogueProcessor},
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	38 and once it is initialized processing of
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	39 L{DialogueSections<DialogueSection>} and
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 L{DialogueResponses<DialogueResponse>} can be initiated via the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41 L{continueDialogue} and L{reply} class methods.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43 The state of dialogue processing is stored via the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	44 L{dialogue_section_stack} class attribute, which stores a list of
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45 L{DialogueSections<DialogueSection>} that have been or are currently being
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	46 processed. Each time L{reply} is called with a L{DialogueResponse} its
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	47 next_section_id attribute is used to select a new L{DialogueSection} from
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	48 the L{dialogue}. The selected L{DialogueSection} is then pushed
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	49 onto the end of the L{dialogue_section_stack}, ready to be processed via
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	50 L{continueDialogue}. The exception to this rule occurs when L{reply} is
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	51 called with a L{DialogueResponse} whose next_section_id attribute is "end"
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	52 or "back". "end" terminates the dialogue as described below, while "back"
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	53 removes the last L{DialogueSection} on the L{dialogue_section_stack}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	54 effectively going back to the previous section of dialogue.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	55
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	56 The L{DialogueProcessor} terminates dialogue processing once L{reply} is
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	57 called with a L{DialogueResponse} whose next_section_id == 'end'.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	58 Processing can also be manually terminated by calling the L{endDialogue}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59 class method.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	60
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	61 @note: See the dialogue_demo.py script for a complete example of how the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	62 L{DialogueProcessor} can be used.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	63
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	64 @ivar dialogue: dialogue data currently being processed.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 @type dialogue: L{Dialogue}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 @ivar dialogue_section_stack: sections of dialogue that have been or are
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67 currently being processed.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 @type dialogue_section_stack: list of L{DialogueSections<DialogueSection>}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 @ivar game_state: objects defining the game state that should be made
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70 available for testing L{DialogueResponse} conditionals.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71 @type game_state: dict of Python objects
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72 @ivar in_dialogue: whether a dialogue has been initiated.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	73 @type in_dialogue: Bool
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	74
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	75 Usage:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	76 >>> game_state = {'pc': player_character, 'quest': quest_engine}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	77 >>> dialogue_processor = DialogueProcessor(dialogue, game_state)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	78 >>> dialogue_processor.initiateDialogue()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	79 >>> while dialogue_processor.in_dialogue:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	80 ... valid_responses = dialogue_processor.continueDialogue()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	81 ... response = choose_response(valid_responses)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	82 ... dialogue_processor.reply(response)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	83 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	84 _logger = logging.getLogger('dialogueengine.DialogueProcessor')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	85
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	86 def dialogue():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	87 def fget(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	88 return self._dialogue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	89
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	90 def fset(self, dialogue):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	91 assert isinstance(dialogue, Dialogue), \
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	92 '{0} does not implement Dialogue interface'.format(dialogue)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	93 self._dialogue = dialogue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	94
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	95 return locals()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	96 dialogue = property(**dialogue())
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	97
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	98 def dialogue_section_stack():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	99 def fget(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	100 return self._dialogue_section_stack
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	101
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	102 def fset(self, new_value):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	103 assert isinstance(new_value, Sequence) and not \
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	104 isinstance(new_value, basestring), \
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	105 'dialogue_section_stack must be a Sequence, not {0}'\
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	106 .format(new_value)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	107 self._dialogue_section_stack = new_value
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	108
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	109 return locals()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	110 dialogue_section_stack = property(**dialogue_section_stack())
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	111
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	112 def game_state():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	113 def fget(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	114 return self._game_state
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	115
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	116 def fset(self, new_value):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	117 assert isinstance(new_value, MutableMapping),\
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	118 'game_state must be a MutableMapping, not {0}'\
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	119 .format(new_value)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	120 self._game_state = new_value
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	121
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	122 return locals()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	123 game_state = property(**game_state())
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	124
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	125 def in_dialogue():
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	126 def fget(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	127 return self._in_dialogue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	128
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	129 def fset(self, value):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	130 assert isinstance(value, bool), '{0} is not a bool'.format(value)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	131 self._in_dialogue = value
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	132
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	133 return locals()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	134 in_dialogue = property(**in_dialogue())
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	135
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	136 def __init__(self, dialogue, game_state):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	137 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	138 Initialize a new L{DialogueProcessor} instance.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	139
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	140 @param dialogue: dialogue data to process.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	141 @type dialogue: L{Dialogue}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	142 @param game_state: objects defining the game state that should be made
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	143 available for testing L{DialogueResponse} conditions.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	144 @type game_state: dict of objects
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	145 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	146 self._dialogue_section_stack = []
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	147 self._dialogue = dialogue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	148 self._game_state = game_state
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	149 self._in_dialogue = False
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	150
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	151 def getDialogueGreeting(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	152 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	153 Evaluate the L{RootDialogueSections<RootDialogueSection>} conditions
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	154 and return the valid L{DialogueSection} which should be displayed
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	155 first.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	156
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	157 @return: Valid root dialogue section.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	158 @rtype: L{DialogueSection}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	159
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	160 @raise: RuntimeError - evaluation of a DialogueGreeting condition fails
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	161 by raising an exception (e.g. due to a syntax error).
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	162 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	163 dialogue = self.dialogue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	164 dialogue_greeting = None
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	165 for greeting in dialogue.greetings:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	166 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	167 condition_met = eval(greeting.condition, self.game_state)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	168 except Exception as exception:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	169 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	170 exception raised in DialogueGreeting {id} condition:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	171 {exception}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	172 ''').format(id=greeting.id, exception=exception)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	173 self._logger.error(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	174 if (condition_met):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	175 dialogue_greeting = greeting
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	176 if (dialogue_greeting is None):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	177 dialogue_greeting = dialogue.default_greeting
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	178
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	179 return dialogue_greeting
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	180
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	181 def initiateDialogue(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	182 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	183 Prepare the L{DialogueProcessor} to process the L{Dialogue} by pushing
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	184 the starting L{DialogueSection} onto the L{dialogue_section_stack}.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	185
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	186 @raise RuntimeError: Unable to determine the root L{DialogueSection}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	187 defined by the L{Dialogue}.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	188 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	189 if (self.in_dialogue):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	190 self.endDialogue()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	191 dialogue_greeting = self.getDialogueGreeting()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	192 self.dialogue_section_stack.append(dialogue_greeting)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	193 self.in_dialogue = True
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	194 self._logger.info('initiated dialogue {0}'.format(self.dialogue))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	195
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	196 def continueDialogue(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	197 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	198 Process the L{DialogueSection} at the top of the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	199 L{dialogue_section_stack}, run any L{DialogueActions<DialogueActions>}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	200 it contains and return a list of valid
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	201 L{DialogueResponses<DialogueResponses> after evaluating any response
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	202 conditionals.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	203
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	204 @returns: valid responses.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	205 @rtype: list of L{DialogueResponses<DialogueResponse>}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	206
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	207 @raise RuntimeError: Any preconditions are not met.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	208
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	209 @precondition: dialogue has been initiated via L{initiateDialogue}.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	210 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	211 if (not self.in_dialogue):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	212 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	213 dialogue has not be initiated via initiateDialogue yet
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	214 ''')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	215 raise RuntimeError(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	216 current_dialogue_section = self.getCurrentDialogueSection()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	217 self.runDialogueActions(current_dialogue_section)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	218 valid_responses = self.getValidResponses(current_dialogue_section)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	219
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	220 return valid_responses
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	221
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	222 def getCurrentDialogueSection(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	223 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	224 Return the L{DialogueSection} at the top of the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	225 L{dialogue_section_stack}.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	226
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	227 @returns: section of dialogue currently being processed.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	228 @rtype: L{DialogueSection}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	229
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	230 @raise RuntimeError: Any preconditions are not met.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	231
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	232 @precondition: dialogue has been initiated via L{initiateDialogue} and
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	233 L{dialogue_section_stack} contains at least one L{DialogueSection}.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	234 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	235 if (not self.in_dialogue):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	236 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	237 getCurrentDialogueSection called but the dialogue has not been
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	238 initiated yet
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	239 ''')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	240 raise RuntimeError(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	241 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	242 current_dialogue_section = self.dialogue_section_stack[-1]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	243 except IndexError:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	244 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	245 getCurrentDialogueSection called but no DialogueSections are in
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	246 the stack
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	247 ''')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	248 raise RuntimeError(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	249
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	250 return current_dialogue_section
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	251
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	252 def runDialogueActions(self, dialogue_node):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	253 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	254 Execute all L{DialogueActions<DialogueActions>} contained by a
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	255 L{DialogueSection} or L{DialogueResponse}.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	256
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	257 @param dialogue_node: section of dialogue or response containing the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	258 L{DialogueActions<DialogueAction>} to execute.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	259 @type dialogue_node: L{DialogueNode}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	260 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	261 self._logger.info('processing commands for {0}'.format(dialogue_node))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	262 for command in dialogue_node.actions:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	263 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	264 command(self.game_state)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	265 except (Exception,) as error:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	266 self._logger.error('failed to execute DialogueAction {0}: {1}'
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	267 .format(command.keyword, error))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	268 # TODO Technomage 2010-11-18: Undo previous actions when an
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	269 # action fails to execute.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	270 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	271 self._logger.debug('ran {0} with arguments {1}'
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	272 .format(getattr(type(command), '__name__'),
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	273 command.arguments))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	274
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	275 def getValidResponses(self, dialogue_section):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	276 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	277 Evaluate all L{DialogueResponse} conditions for a L{DialogueSection}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	278 and return a list of valid responses.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	279
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	280 @param dialogue_section: section of dialogue containing the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	281 L{DialogueResponses<DialogueResponse>} to process.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	282 @type dialogue_section: L{DialogueSection}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	283
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	284 @return: responses whose conditions were met.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	285 @rtype: list of L{DialogueResponses<DialogueResponse>}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	286 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	287 valid_responses = []
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	288 for dialogue_response in dialogue_section.responses:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	289 condition = dialogue_response.condition
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	290 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	291 condition_met = condition is None or \
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	292 eval(condition, self.game_state)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	293 except (Exception,) as exception:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	294 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	295 evaluation of condition {condition} for {response} failed
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	296 with error: {exception}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	297 ''').format(condition=dialogue_response.condition,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	298 response=dialogue_response, exception=exception)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	299 self._logger.error(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	300 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	301 self._logger.debug(
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	302 'condition "{0}" for {1} evaluated to {2}'
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	303 .format(dialogue_response.condition, dialogue_response,
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	304 condition_met)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	305 )
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	306 if (condition_met):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	307 valid_responses.append(dialogue_response)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	308
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	309 return valid_responses
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	310
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	311 def reply(self, dialogue_response):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	312 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	313 Reply with a L{DialogueResponse}, execute the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	314 L{DialogueActions<DialogueAction>} it contains and push the next
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	315 L{DialogueSection} onto the L{dialogue_section_stack}.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	316
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	317 @param dialogue_response: response to reply with.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	318 @type dialogue_response: L{DialogueReponse}
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	319
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	320 @raise RuntimeError: Any precondition is not met.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	321
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	322 @precondition: L{initiateDialogue} must be called before this method
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	323 is used.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	324 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	325 if (not self.in_dialogue):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	326 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	327 reply cannot be called until the dialogue has been initiated
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	328 via initiateDialogue
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	329 ''')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	330 raise RuntimeError(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	331 self._logger.info('replied with {0}'.format(dialogue_response))
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	332 # FIXME: Technomage 2010-12-11: What happens if runDialogueActions
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	333 # raises an error?
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	334 self.runDialogueActions(dialogue_response)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	335 next_section_id = dialogue_response.next_section_id
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	336 if (next_section_id == 'back'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	337 if (len(self.dialogue_section_stack) == 1):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	338 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	339 attempted to run goto: back action but stack does not
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	340 contain a previous DialogueSection
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	341 ''')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	342 raise RuntimeError(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	343 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	344 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	345 self.dialogue_section_stack.pop()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	346 except (IndexError,):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	347 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	348 attempted to run goto: back action but the stack was
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	349 empty
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	350 ''')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	351 raise RuntimeError(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	352 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	353 self._logger.debug(
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	354 'ran goto: back action, restored last DialogueSection'
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	355 )
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	356 elif (next_section_id == 'end'):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	357 self.endDialogue()
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	358 self._logger.debug('ran goto: end action, ended dialogue')
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	359 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	360 try:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	361 next_dialogue_section = \
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	362 self.dialogue.sections[next_section_id]
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	363 except KeyError:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	364 error_message = dedent_chomp('''
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	365 {0} is not a recognized goto: action or DialogueSection
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	366 identifier
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	367 ''').format(next_section_id)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	368 raise RuntimeError(error_message)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	369 else:
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	370 self.dialogue_section_stack.append(next_dialogue_section)
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	371
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	372 def endDialogue(self):
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	373 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	374 End the current dialogue and clean up any resources in use by the
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	375 L{DialogueProcessor}.
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	376 """
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	377 self.dialogue_section_stack = []
1fd2201f5c36 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	378 self.in_dialogue = False

Mercurial > parpg-core

annotate src/parpg/dialogueprocessor.py @ 71:2168d761d865