class GameState(object):
"""This class holds the current state of the game."""
def __init__(self, quests_dir = None):
self.player_character = None
self.quest_engine = QuestEngine(quests_dir)
self.quest_engine.readQuests()
self.objects = {}
self.object_ids = {}
self.current_map_name = None
self.maps = {}
self.npcs_met = set()
self.funcs = {
"__builtins__":None,
"help":script_help,
"sqrt":math.sqrt,
"log":math.log,
"str":str,
"meet":self.meet,
"met":self.met,
}
self.locals = {}
def addObject(self, object_id, map_id, game_object):
"""Adds an object to the objects and object_ids
dictionaries.
@param object_id: ID of the object
@type object_id: str
@param map_id: ID of the map the object is on.
If the object is in a container this has to be None
@type map_id: str or None
@param object: object to be added
@type object: GameObject
"""
if not self.object_ids.has_key(object_id):
if not self.objects.has_key(map_id):
self.objects[map_id] = {}
self.objects[map_id][object_id] = game_object
self.object_ids[object_id] = map_id
def deleteObject(self, object_id):
"""Removes an object from the dictionaries
@param object_id: ID of the object
@type object_id: str
@returns The deleted object
"""
if self.hasObject(object_id):
map_id = self.getMapOfObject(object_id)
if map_id:
inst = self.maps[map_id].agent_layer.getInstance(object_id)
self.maps[map_id].agent_layer.deleteInstance(inst)
obj = self.objects[map_id][object_id]
del self.objects[map_id][object_id]
del self.object_ids[object_id]
return obj
return None
def getObjectsFromMap(self, map_id):
"""Gets all objects that are currently on the given map.
@type map: String
@param map: The map name.
@returns: The list of objects on this map. Or an empty list"""
return [i for i in self.getObjectDictOfMap(map_id).values()
if map_id in self.objects]
def getObjectDictOfMap(self, map_id):
if map_id in self.objects:
return self.objects[map_id]
return {}
def deleteObjectsFromMap(self, map_id):
"""Deletes all objects of the given map.
@type map: String
@param map: The map name.
@returns: None"""
deleted_objs = []
if map_id in self.objects:
for obj in self.objects[map_id].copy():
deleted_objs.append(self.deleteObject(obj))
return deleted_objs
def hasObject(self, object_id):
"""Check if an object with the given id is present
@param object_id: ID of the object
@type object_id: str
@return: True if there is an object False if not
"""
return self.object_ids.has_key(object_id)
def getMapOfObject(self, object_id):
"""Returns the map the object is on.
@param object_id: ID of the object
@type object_id: str
@return: Name of the map the object is on.
If there is no such object or the object is in a container None is returned
"""
if self.object_ids.has_key(object_id):
return self.object_ids[object_id]
return None
def getObjectById(self, obj_id, map_id = None):
"""Gets an object by its object id and map id
@type obj_id: String
@param obj_id: The id of the object.
@type map_id: String
@param map_id: It id of the map containing the object.
@returns: The object or None."""
if not map_id:
map_id = self.getMapOfObject(obj_id)
if not map_id in self.objects:
self.objects[map_id] = {}
if obj_id in self.objects[map_id]:
return self.objects[map_id][obj_id]
def clearObjects(self):
"""Delete all objects from the state
"""
self.objects = {}
self.object_ids = {}
def getStateForSaving(self):
"""Prepares state for saving
@type state: dictionary
@param state: State of the object
"""
ret_dict = {}
ret_dict["CurrentMap"] = self.current_map_name
ret_dict["Quests"] = self.quest_engine.getStateForSaving()
ret_dict["NPCsMet"] = self.npcs_met
ret_dict["locals"] = self.locals
return ret_dict
def restoreFromState(self, state):
"""Restores the state"""
self.current_map_name = state["CurrentMap"]
self.npcs_met = state["NPCsMet"]
self.locals = state["locals"]
self.quest_engine.readQuests()
self.quest_engine.restoreFromState(state["Quests"])
def meet(self, npc):
"""Record that the PC has met a certain NPC
@type npc: str
@param npc: The NPC's name or id"""
if npc in self.npcs_met:
# we could raise an error here, but should probably be a warn
# raise RuntimeError("I already know %s" % npc)
return
self.npcs_met.add(npc)
def met(self, npc):
"""Indicate whether the PC has met this npc before
@type npc: str
@param npc: The NPC's name or id
@return: None"""
return npc in self.npcs_met
def getGameEnvironment(self):
"""Returns a 2 item list containing the entities and functions that
can work with it. This can be used in functions like eval or exec"""
globals = {}
globals.update(self.funcs)
globals.update(self.getObjectDictOfMap(self.current_map_name))
return globals, self.locals