parpg-source: gamestate.py annotate

annotate gamestate.py @ 89:939984cff702

Added Base component, which has a saveable_fields property. It is supposed to be derived from, thus it is not in the components list.

author	KarstenBock@gmx.net
date	Tue, 27 Sep 2011 14:58:03 +0200
parents	0411a4bcceee
children	824f3068ef2a

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 from parpg.quest_engine import QuestEngine
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	17
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	18 class GameState(object):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	19 """This class holds the current state of the game."""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	20 def __init__(self, quests_dir = None):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	21 self.player_character = None
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	22 self.quest_engine = QuestEngine(quests_dir)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	23 self.quest_engine.readQuests()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	24 self.objects = {}
75 9e03f7816061 (Re)added setting of inventory and equipment in the object files. KarstenBock@gmx.net parents: 74 diff changeset	25 self.objects[None] = {}
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	26 self.object_ids = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	27 self.current_map_name = None
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	28 self.maps = {}
58 d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	29 self.npcs_met = set()
0 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
73 5c751b9a3d8b The addObject method of the GameState class now accepts an object_id parameter, instead of it getting that value from the object. KarstenBock@gmx.net parents: 58 diff changeset	32 def addObject(self, object_id, map_id, game_object):
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	33 """Adds an object to the objects and object_ids
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	34 dictionaries.
73 5c751b9a3d8b The addObject method of the GameState class now accepts an object_id parameter, instead of it getting that value from the object. KarstenBock@gmx.net parents: 58 diff changeset	35 @param object_id: ID of the object
5c751b9a3d8b The addObject method of the GameState class now accepts an object_id parameter, instead of it getting that value from the object. KarstenBock@gmx.net parents: 58 diff changeset	36 @type object_id: str
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	37 @param map_id: ID of the map the object is on.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	38 If the object is in a container this has to be None
73 5c751b9a3d8b The addObject method of the GameState class now accepts an object_id parameter, instead of it getting that value from the object. KarstenBock@gmx.net parents: 58 diff changeset	39 @type map_id: str or None
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	40 @param object: object to be added
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	41 @type object: GameObject
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	42 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	43 if not self.object_ids.has_key(object_id):
74 c9818290bbe7 Objects that are not on an actual map are now stored under the value None in the gamestates object dictionary. KarstenBock@gmx.net parents: 73 diff changeset	44 self.objects[map_id][object_id] = game_object
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	45 self.object_ids[object_id] = map_id
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	46
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	47 def deleteObject(self, object_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	48 """Removes an object from the dictionaries
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	49 @param object_id: ID of the object
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	50 @type object_id: str
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	51 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	52 if self.hasObject(object_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	53 map_id = self.getMapOfObject(object_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	54 if map_id:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	55 inst = self.maps[map_id].agent_layer.getInstance(object_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	56 self.maps[map_id].agent_layer.deleteInstance(inst)
88 0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	57 self.objects[map_id][object_id].delete()
74 c9818290bbe7 Objects that are not on an actual map are now stored under the value None in the gamestates object dictionary. KarstenBock@gmx.net parents: 73 diff changeset	58 del self.objects[map_id][object_id]
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	59 del self.object_ids[object_id]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	60
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 getObjectsFromMap(self, map_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	63 """Gets all objects that are currently on the given map.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	64 @type map: String
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	65 @param map: The map name.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	66 @returns: The list of objects on this map. Or an empty list"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	67 if map_id in self.objects:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	68 return [i for i in self.objects[map_id].values() \
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	69 if map_id in self.objects]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	70
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	71 return {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	72
88 0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	73 def deleteObjectsFromMap(self, map_id):
0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	74 """Deletes all objects of the given map.
0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	75 @type map: String
0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	76 @param map: The map name.
0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	77 @returns: None"""
0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	78 if map_id in self.objects:
0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	79 for obj in self.objects[map_id].copy():
0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	80 self.deleteObject(obj)
0411a4bcceee Fixed moving between maps. KarstenBock@gmx.net parents: 75 diff changeset	81
0 7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	82 def hasObject(self, object_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	83 """Check if an object with the given id is present
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	84 @param object_id: ID of the object
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	85 @type object_id: str
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	86 @return: True if there is an object False if not
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	87 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	88 return self.object_ids.has_key(object_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	89
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	90 def getMapOfObject(self, object_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	91 """Returns the map the object is on.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	92 @param object_id: ID of the object
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	93 @type object_id: str
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	94 @return: Name of the map the object is on.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	95 If there is no such object or the object is in a container None is returned
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 if self.object_ids.has_key(object_id):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	98 return self.object_ids[object_id]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	99 return None
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	100
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	101 def getObjectById(self, obj_id, map_id = None):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	102 """Gets an object by its object id and map id
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	103 @type obj_id: String
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	104 @param obj_id: The id of the object.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	105 @type map_id: String
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	106 @param map_id: It id of the map containing the object.
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	107 @returns: The object or None."""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	108 if not map_id:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	109 map_id = self.getMapOfObject(obj_id)
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	110 if not map_id in self.objects:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	111 self.objects[map_id] = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	112 if obj_id in self.objects[map_id]:
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	113 return self.objects[map_id][obj_id]
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 def clearObjects(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	116 """Delete all objects from the state
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	117 """
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	118 self.objects = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	119 self.object_ids = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	120
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	121 def getStateForSaving(self):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	122 """Prepares state for saving
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	123 @type state: dictionary
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	124 @param state: State of the object
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 ret_dict = {}
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	127 ret_dict["CurrentMap"] = self.current_map_name
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	128 ret_dict["Quests"] = self.quest_engine.getStateForSaving()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	129 return ret_dict
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	130
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	131 def restoreFromState(self, state):
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	132 """Restores the state"""
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	133 self.current_map_name = state["CurrentMap"]
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	134 self.quest_engine.readQuests()
7a89ea5404b1 Initial commit of parpg-core. M. George Hansen <technopolitica@gmail.com> parents: diff changeset	135 self.quest_engine.restoreFromState(state["Quests"])
58 d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	136
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	137 def meet(self, npc):
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	138 """Record that the PC has met a certain NPC
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	139 @type npc: str
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	140 @param npc: The NPC's name or id"""
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	141 if npc in self.npcs_met:
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	142 # we could raise an error here, but should probably be a warn
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	143 # raise RuntimeError("I already know %s" % npc)
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	144 return
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	145 self.npcs_met.add(npc)
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	146
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	147 def met(self, npc):
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	148 """Indicate whether the PC has met this npc before
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	149 @type npc: str
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	150 @param npc: The NPC's name or id
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	151 @return: None"""
d4f213b99d41 Added meet and met methods from the old player object to the gamestate. KarstenBock@gmx.net parents: 44 diff changeset	152 return npc in self.npcs_met

Mercurial > parpg-source

annotate gamestate.py @ 89:939984cff702