Vega strike Python Modules doc: DynamicNewsData Class Reference

All Data Structures Namespaces Files Functions Variables

Public Member Functions
def	__init__

def	getFactionData

def	translateKeyToDictionary

def	makeNewsKeyList

def	getNewsList

def	getBestMatch

Data Fields
	faction_dict

	news_dict

Detailed Description

Each instance of this class acts as an accessor to
the faction specific information stored for the purpose
of translating news stories.

Definition at line 141 of file dynamic_news.py.

Constructor & Destructor Documentation

def __init__ ( self)

Definition at line 145 of file dynamic_news.py.

 
   def __init__(self):
     import dynamic_news_content
     self.faction_dict = dynamic_news_content.allFactionNames()
     self.news_dict = dynamic_news_content.allNews()

Member Function Documentation

def getBestMatch	(	self,
		stories,
		varlist
	)

From the provided list of stories, return the
item who's \"scale\" most closely matches that of
the given event (minimise variance).

Definition at line 227 of file dynamic_news.py.

References debug.error, and locale.str().

 
   def getBestMatch(self, stories, varlist):
     """From the provided list of stories, return the
     item who's \"scale\" most closely matches that of
     the given event (minimise variance)."""
     kw_stories = list()
     for story in stories:
       if story[1] == varlist[NewsManager.EVENT_KEYWORD_INDEX]:
         kw_stories.append(story)
     if not len(kw_stories):
       debug.error("ERROR: NO KEYWORD STORIES AVAILABLE FOR "+str(varlist))
       return False
     if len(kw_stories) == 1:
       return kw_stories[0]
     scale_stories = list()
     scale_stories.append(kw_stories[0])
     diff = abs(int(1000*scale_stories[0][0]) - int(1000*varlist[NewsManager.EVENT_SCALE_INDEX]))
     kw_stories.pop(0)
     for story in kw_stories:
       if abs(int(1000*scale_stories[0][0]) - int(1000*varlist[NewsManager.EVENT_SCALE_INDEX])) < diff:
         scale_stories = list()
         scale_stories.append(story)
       elif abs(int(1000*scale_stories[0][0]) - int(1000*varlist[NewsManager.EVENT_SCALE_INDEX])) == diff:
         scale_stories.append(story)
     return scale_stories[varlist[NewsManager.RANDOM_INTEGER_INDEX] % len(scale_stories)]

def getFactionData	(	self,
		faction,
		variable
	)

Return the variable information stored for this
faction.

Definition at line 150 of file dynamic_news.py.

References debug.error, and DynamicNewsData.faction_dict.

 
   def getFactionData(self, faction, variable):
     """Return the variable information stored for this
     faction."""
     if variable in self.faction_dict["alltags"]:
       try:
         return self.faction_dict[faction][variable]
       except:
         # raise ValueError("Invalid Faction Specified")
         debug.error("ERROR: FACTION LOOKUP ERROR faction %s variable %s" % (faction, variable))
         return self.faction_dict['unknown'][variable]
     else:
       debug.error("ERROR: VARIABLE LOOKUP ERROR faction %s variable %s" % (faction, variable))
       return "VARIABLE LOOKUP ERROR"

def getNewsList	(	self,
		key_list,
		get_neutral = `False`
	)

Searches the item dictionary to find matching
items for this given event.

Definition at line 214 of file dynamic_news.py.

References DynamicNewsData.news_dict.

 
   def getNewsList(self, key_list, get_neutral=False):
     """Searches the item dictionary to find matching
     items for this given event."""
     story_list = self.news_dict
     try:
       if get_neutral:
         key_list[0] = "neutral"
       for key in key_list:
         story_list = story_list[key]
     except:
       return list()
     return story_list

def makeNewsKeyList	(	self,
		news_list,
		news_faction,
		pov
	)

Creates a list of the structure used to store
each news event.

Definition at line 203 of file dynamic_news.py.

References DynamicNewsData.translateKeyToDictionary().

 
   def makeNewsKeyList(self, news_list, news_faction, pov):
     """Creates a list of the structure used to store
     each news event."""
     key_list = list()
     key_list.append(news_faction)
     key_list.append(news_list[NewsManager.EVENT_TYPE_INDEX])
     key_list.append(news_list[NewsManager.EVENT_STAGE_INDEX])
     key_list.append(self.translateKeyToDictionary(news_list[NewsManager.AGGRESSOR_SUCCESS_INDEX]))
     key_list.append(self.translateKeyToDictionary(pov))
     return key_list

def translateKeyToDictionary	(	self,
		variable
	)

Translates the information from the stored
values to those used to lookup items in the item
dictionary.

Definition at line 164 of file dynamic_news.py.

 
   def translateKeyToDictionary(self, variable):
     """Translates the information from the stored
     values to those used to lookup items in the item
     dictionary."""
     replace = ""
     if variable == NewsManager.KEYWORD_DEFAULT:
       replace = "all"
     elif variable == NewsManager.TYPE_SIEGE:
       replace = "siege"
     elif variable == NewsManager.TYPE_EXPLORATION:
       replace = "exploration"
     elif variable == NewsManager.TYPE_BATTLE:
       replace = "battle"
     elif variable == NewsManager.TYPE_FLEETBATTLE:
       replace = "fleetbattle"
     elif variable == NewsManager.TYPE_DESTROYED:
       replace = "destroyed"
     elif variable == NewsManager.STAGE_BEGIN:
       replace = "start"
     elif variable == NewsManager.STAGE_MIDDLE:
       replace = "middle"
     elif variable == NewsManager.STAGE_END:
       replace = "end"
     elif variable == NewsManager.SUCCESS_WIN:
       replace = "success"
     elif variable == NewsManager.SUCCESS_DRAW:
       replace = "draw"
     elif variable == NewsManager.SUCCESS_LOSS:
       replace = "loss"
     elif variable == NewsManager.POV_GOOD:
       replace = "good"
     elif variable == NewsManager.POV_BAD:
       replace = "bad"
     elif variable == NewsManager.POV_NEUTRAL:
       replace = "neutral"
     else:
       raise TypeError("Unrecognised variable")
     return replace

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation