parpg-source: quest_engine.py annotate

annotate quest_engine.py @ 95:d67e8288e9bf

Added saveable_fields to Container.

author	KarstenBock@gmx.net
date	Tue, 27 Sep 2011 15:57:36 +0200
parents	06145a6ee387
children

rev	line source
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	1 # This file is part of PARPG.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	2
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	6 # (at your option) any later version.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	7
7a89ea5404b1 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,
7a89ea5404b1 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
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	11 # GNU General Public License for more details.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	12
7a89ea5404b1 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
7a89ea5404b1 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/>.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	15
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	16 import yaml
2 06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	17
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	18 from parpg.common.utils import locateFiles
2 06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	19 from parpg import vfs
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	20
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	21 class Quest(object):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	22 """Class that holds the information for a quest"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	23 def __init__(self, quest_id, quest_giver_id, quest_name, description,
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	24 variables):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	25 self.quest_id = quest_id
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	26 self.quest_giver_id = quest_giver_id
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	27 self.quest_name = quest_name
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28 self.description = description
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	29 self.quest_variables = variables
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	30
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	31 def setValue(self, variable_name, value):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	32 """Set the value of a quest variable
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33 @param variable_name: the name of the variable to set
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	34 @param value: the value you want to assign to the variable
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	35 @return: True on success
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	36 @return: False when it failes"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	37
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	38 if self.quest_variables.has_key(variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	39 self.quest_variables[variable_name]["value"] = value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 return True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	44 def getValue(self, variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45 """Get the value of a quest_variable
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	46 @param variable_name: the name of the variable to set
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	47 @return: the value of the quest_variable"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	48 if self.quest_variables.has_key(variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	49 return self.quest_variables[variable_name]["value"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	50 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	51 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	52
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	53 def getGoalValue(self, variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	54 """Get the goal value of a quest_variable
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	55 @param variable_name: the name of the variable to set
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	56 @return: the goal value of the quest variable"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	57 if self.quest_variables.has_key(variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	58 return self.quest_variables[variable_name]["goal_value"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	60 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	61
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	62 def increaseValue(self, variable_name, value):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	63 """Increase a variable by a specified value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	64 @param variable_name: the name of the variable to set
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 @param value: the value you want to increase the variable with
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 @return: True on success
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67 @return: False when it fails"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 if self.quest_variables.has_key(variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 self.quest_variables[variable_name]["value"] += value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70 return True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	73
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	74 def decreaseValue(self, variable_name, value):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	75 """Decrease a variable by a specified value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	76 @param variable_name: the name of the variable to set
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	77 @param value: the value you want to decrease the variable with
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	78 @return: True on success
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	79 @return: False when it failes"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	80 if self.quest_variables.has_key(variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	81 self.quest_variables[variable_name]["value"] -= value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	82 return True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	83 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	84 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	85
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	86 def isGoalValue(self, variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	87 """Check if the variable has reached it's goal value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	88 @param variable_name: the name of the variable to check
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	89 @return: True when the variable has reached the goal value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	90 @return: False when it has not reached the goal value"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	91 if self.quest_variables.has_key(variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	92 return self.quest_variables[variable_name]["value"] == \
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	93 self.quest_variables[variable_name]["goal_value"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	94 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	95 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	96
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	97 def isEqualOrBiggerThanGoalValue(self, variable_name):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	98 """Check if the variable is equil or bigger then it's goal value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	99 @param variable_name: the name of the variable to set
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	100 @return: True when it has reached or exceeded the goal value
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	101 @return: False when it has not reached or exceeded the goal value """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	102 if variable_name in self.quest_variables:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	103 return self.quest_variables[variable_name]["value"] >= \
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	104 self.quest_variables[variable_name]["goal_value"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	105 else:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	106 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	107
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	108 def restartQuest(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	109 """Restarts the quest. This sets all values to the reset values,
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	110 if there is a reset value present """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	111 for variable in self.quest_variables.itervalues():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	112 if variable.has_key("reset_value"):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	113 variable["value"] = variable["reset_value"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	114
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	115 class QuestEngine(dict):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	116 def __init__(self, quest_dir):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	117 """Create a quest engine object"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	118 dict.__init__(self)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	119 self.empty_quest = Quest(None, None, None, None, {})
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	120 self.quests = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	121 self.active_quests = []
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	122 self.finished_quests = []
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	123 self.failed_quests = []
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	124 self.quest_dir = quest_dir
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	125
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	126 def __str__(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	127 return self.quests.__str__()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	128
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	129 def __getitem__(self, key):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	130 try:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	131 return self.quests.__getitem__(key)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	132 except KeyError:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	133 return self.empty_quest
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	134
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	135 def items(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	136 return self.quests.items()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	137
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	138 def values(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	139 return self.quests.values()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	140
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	141 def keys(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	142 return self.quests.keys()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	143
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	144 def readQuests(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	145 """Reads in the quests in the quest directory"""
2 06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	146 filepaths = locateFiles("*.yaml", self.quest_dir)
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	147 self.quests = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	148 self.active_quests = []
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	149 self.finished_quests = []
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	150 self.failed_quests = []
2 06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	151 for filepath in filepaths:
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	152 quest_file = vfs.VFS.open(filepath)
06145a6ee387 Fixed resource path dependencies issue that caused PARPG to crash on start. M. George Hansen <technopolitica@gmail.com> parents: 0 diff changeset	153 tree = yaml.load(quest_file)
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	154 quest_properties = tree["QUEST_PROPERTIES"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	155 variable_defines = tree["DEFINES"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	156
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	157 self.quests[quest_properties["quest_id"]] = \
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	158 Quest(quest_properties["quest_id"],
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	159 quest_properties["quest_giver_id"],
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	160 quest_properties["quest_name"],
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	161 quest_properties["description"],
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	162 variable_defines)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	163
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	164 def activateQuest(self, quest_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	165 """Add a quest to the quest log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	166 @param quest: the quest id of the quest to add to the quest log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	167 @return: True if succesfully added
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	168 @return: False if failed to add"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	169
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	170 if quest_id in self.quests \
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	171 and not (quest_id in self.active_quests \
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	172 or quest_id in self.finished_quests):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	173 self.active_quests.append(quest_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	174 return True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	175 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	176
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	177 def finishQuest(self, quest_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	178 """Move a quest to the finished quests log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	179 @param quest_id: The id of the quest you want to move
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	180 @return: True on success
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	181 @return: False when it failes"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	182 if quest_id in self.active_quests:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	183 self.finished_quests.append(quest_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	184 self.active_quests.remove(quest_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	185 return True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	186 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	187
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	188 def restartQuest(self, quest_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	189 """Restart a quest
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	190 @param quest_id: ID of the quest you want to restart
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	191 @return: True on success
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	192 @return: False when it failes"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	193 if quest_id in self.active_quests:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	194 self.quests[quest_id].restartQuest()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	195
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	196 def failQuest(self, quest_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	197 """Set a quest to failed
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	198 @param quest_id: ID of the quest you want to fail
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	199 @return: True on success
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	200 @return: False when it failes"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	201 if quest_id in self.active_quests:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	202 self.failed_quests.append(quest_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	203 self.active_quests.remove(quest_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	204 return True
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	205 return False
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	206
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	207 def hasQuest(self, quest_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	208 """Check whether a quest is present in the quest_list.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	209 It doesn't matter which state the quest is, or even if its
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	210 started.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	211 @param quest_id: ID of the quest you want to check
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	212 @return: True on when the quest is in the quest log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	213 @return: False when it's not in the quest log"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	214 return quest_id in self.quests
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	215
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	216 def hasActiveQuest(self, quest_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	217 """Check whether a quest is in the quest log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	218 @param quest_id: ID of the quest you want to check
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	219 @return: True on when the quest is in the quest log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	220 @return: False when it's not in the quest log"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	221 return quest_id in self.active_quests
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	222
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	223 def hasFinishedQuest(self, quest_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	224 """Check whether a quest is in the finished quests log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	225 @param quest_id: ID of the quest you want to check
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	226 @return: True on when the quest is in the finished quests log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	227 @return: False when it's not in the finished quests log"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	228 return quest_id in self.finished_quests
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	229
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	230 def hasFailedQuest(self, quest_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	231 """Check whether a quest is in the failed quests log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	232 @param quest_id: ID of the quest you want to check
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	233 @return: True on when the quest is in the failed quests log
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	234 @return: False when it's not in the failed quests log"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	235 return quest_id in self.failed_quests
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	236
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	237 def getStateForSaving(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	238 """Prepares state for saving
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	239 @type state: dictionary
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	240 @param state: State of the object"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	241 ret_dict = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	242 variables_dict = ret_dict["Variables"] = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	243 for quest in self.quests.itervalues():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	244 quest_dict = variables_dict[quest.quest_id] = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	245 for variable, data in quest.quest_variables.iteritems():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	246 quest_dict[variable] = data["value"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	247 ret_dict["ActiveQuests"] = self.active_quests
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	248 ret_dict["FinishedQuests"] = self.finished_quests
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	249 ret_dict["FailedQuests"] = self.failed_quests
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	250 return ret_dict
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	251
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	252 def restoreFromState(self, state):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	253 """Restores the state"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	254 variables_dict = state["Variables"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	255 for quest_id, variables in variables_dict.iteritems():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	256 for variable, value in variables.iteritems():
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	257 self.quests[quest_id].setValue(variable, value)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	258 self.active_quests = state["ActiveQuests"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	259 self.finished_quests = state["FinishedQuests"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	260 self.failed_quests = state["FailedQuests"]

Mercurial > parpg-source

annotate quest_engine.py @ 95:d67e8288e9bf