Vega strike Python Modules doc: mission

def mission_lib.AddNewMission	(	which,
		args,
		constructor = `None`,
		briefing0 = `''`,
		briefing1 = `''`,
		vars0 = `None`,
		vars1 = `None`
	)

Adds a mission to the list of missions stored in playerInfo.

Definition at line 281 of file mission_lib.py.

References addPlayer(), getMissionPlayer(), custom.run(), and locale.str().

 
 def AddNewMission(which,args,constructor=None,briefing0='',briefing1='',vars0=None,vars1=None):
     """ Adds a mission to the list of missions stored in playerInfo. """
     if not isinstance(vars0,dict):
         vars0 = dict()
         vars1 = vars0
     if VS.isserver():
         lenvars0=len(vars0)
         sendargs = ["AddNewMission", which, briefing0, briefing1,lenvars0]
         for key in vars0:
             sendargs.append(key)
             sendargs.append(vars0[key])
         custom.run("mission_lib", sendargs, None)
     
     plr = getMissionPlayer()
     addPlayer(plr, False)
     playerInfo = players[plr]
     
     which = str(which)
     playerInfo.last_constructor[which] = constructor
     playerInfo.last_args[which] = args
     playerInfo.last_briefing[0][which] = briefing0
     playerInfo.last_briefing[1][which] = briefing1
     playerInfo.last_briefing_vars[0][which] = vars0
     playerInfo.last_briefing_vars[1][which] = vars1

def mission_lib.addPlayer	(	num,
		reset = `True`
	)

Definition at line 36 of file mission_lib.py.

 
 def addPlayer(num, reset=True):
     while len(players)<=num:
         players.append(PlayerMissionInfo())
     if reset:
         players[num] = PlayerMissionInfo()
 
 addPlayer(VS.getNumPlayers()-1)
 
# addPlayer(0) #single player -- add 0th player.

def mission_lib.BriefLastMission	(	whichid,
		first,
		textbox = `None`,
		template = `'#DESCRIPTION#'`
	)

Outputs the briefing from fixer missions on the base screen.

Definition at line 225 of file mission_lib.py.

References CountMissions(), getMissionPlayer(), dumbdbm.keys(), SetLastMission(), dospath.split(), locale.str(), and debug.warn.

 
 def BriefLastMission(whichid,first,textbox=None,template='#DESCRIPTION#'):
     """ Outputs the briefing from fixer missions on the base screen. """
     plr = getMissionPlayer()
     last_briefing = players[plr].last_briefing
     last_briefing_vars = players[plr].last_briefing_vars
 
     # Compare the given mission id with the id stored in the briefing vars
     # If match is found, retrieve the mission name, which is also the mission key
     which = None
     for name in last_briefing_vars[0]:
         if last_briefing_vars[0][name]['MISSION_ID'] == str(whichid):
             which = name
     # Should not happen anymore, but sometimes missions have all the same id,
     # e.g. 1, and then no missions for id 0 will e found.
     if which == None:
         which = last_briefing_vars[0].keys()[0]
         debug.warn("mission_lib.BriefLastMission couldn't find mission id"+ str(whichid))
         
     if first<0 or first>=len(last_briefing):
         return
     if (which in last_briefing[first]):
         # compute variables
         s_which = str(which).split('/')
         w_prefix = ''
         curmission = s_which[len(s_which)-1]
         if curmission.isdigit():
             # But for numeric identifiers, convert base-0 to base-1 indices
             curmission = str(int(curmission)+1)
         else:
             # allow non-numeric mission identifiers ( 'Disc_1', anyone? )
             currmission = str(whichid)
         for i in s_which[:len(s_which)-1]:
             w_prefix += str(i) + '/'
         nummissions = CountMissions(first,w_prefix)
 
         # replace variables in template
         template = template.replace('#MISSION_NUMBER#',str(curmission))
         template = template.replace('#MISSION_ID#',str(whichid))
         template = template.replace('#GUILD_NAME#',s_which[0])
         template = template.replace('#NUM_MISSIONS#',str(nummissions))
         template = template.replace('#DESCRIPTION#',str(last_briefing[first][which]))
         template = template.replace('#SHORT_DESCRIPTION#',str(last_briefing_vars[first][which]['MISSION_SHORTDESC']))
         try:    
             template = template.replace('#MISSION_TYPE#',last_briefing_vars[first][which]['MISSION_TYPE'])
         except: 
             template = template.replace('#MISSION_TYPE#','')
 
         # set text
         import Base
         if textbox:
             Base.SetTextBoxText(Base.GetCurRoom(),textbox, template)
         else:
             Base.Message (template)
         # Remember this mission as the last one being processed.
         SetLastMission(which)

def mission_lib.CountMissions	(	first,
		prefix
	)

Definition at line 215 of file mission_lib.py.

References getMissionPlayer(), and locale.str().

 
 def CountMissions(first,prefix):
     plr = getMissionPlayer()
     last_briefing = players[plr].last_briefing
     
     nummissions = 0
     for which in last_briefing[first]:
         if str(which).startswith(prefix):
             nummissions = nummissions + 1
     return nummissions

def mission_lib.CreateFixerMissions ( )

This function creates missions with ids "0" and "1" for use with the fixers
on bases.

Definition at line 416 of file mission_lib.py.

References CreateRandomMission(), and vsrandom.random().

 
 def CreateFixerMissions():
     """ This function creates missions with ids "0" and "1" for use with the fixers
     on bases.
     """
     rndnum = vsrandom.random()
     fixers = []
     if rndnum<0.7:
         f = CreateRandomMission(0)
         fixers.append(f)
         img = None
         if f:
             img = f[0]
         rndnum = vsrandom.random()
         if rndnum<0.6:
             i = 0
             newimg = img
             while newimg==img and i<10:
                 f = CreateRandomMission(1)
                 if f:
                     newimg = f[0]
                 i += 1
             if i<10:
                 fixers.append(f)
     return fixers

def mission_lib.CreateGuildMissions	(	guildname,
		nummissions,
		accepttypes,
		prefix = `"#G#"`,
		acceptmsg = `''`
	)

Definition at line 475 of file mission_lib.py.

References AddNewMission(), addPlayer(), CountMissions(), PickleTools.decodeMap(), getMissionPlayer(), PickRandomMission(), and locale.str().

 
 def CreateGuildMissions(guildname,nummissions,accepttypes,prefix="#G#",acceptmsg=''):
     plr=getMissionPlayer()
     addPlayer(plr, False)
     
     goodlist=[]
     for indx in range(Director.getSaveStringLength(plr, "mission_scripts")):
         script=Director.getSaveString(plr,"mission_scripts",indx)
         if (script.find(prefix)!=-1):
             missiontype=script[3:script.find('#',3)]
             freq = 0
             if (accepttypes==None):
                 freq = 1
             elif (missiontype in accepttypes):
                 freq = accepttypes[missiontype]
             elif ('*' in accepttypes):
                 freq = accepttypes['*']
             if freq:
                 goodlist.append( (indx,freq) )
     if len(goodlist)<nummissions:
         nummissions=len(goodlist)
     delit=[]
     for missionnum in range(0,nummissions):
         goodi=PickRandomMission(goodlist)
         if goodi == None:
             break
         i=goodlist[goodi][0]
         which=guildname+'/'+str(missionnum)
         script=Director.getSaveString(plr,"mission_scripts",i)
         desc=Director.getSaveString(plr,"mission_descriptions",i)
         vars=PickleTools.decodeMap( Director.getSaveString(plr,"mission_vars",i) )
         vars.setdefault('MISSION_SHORTDESC',Director.getSaveString(plr,"mission_names",i))
         delit.append(i)
         AddNewMission(which,script,None,desc,acceptmsg,vars,vars)
         goodlist.pop(goodi)
     delit.sort()
     delit.reverse()
     for i in delit:
         Director.eraseSaveString(plr,"mission_scripts",i)
         Director.eraseSaveString(plr,"mission_descriptions",i)
         Director.eraseSaveString(plr,"mission_names",i)
         Director.eraseSaveString(plr,"mission_vars",i)
     #more reliable... sometimes we run out of good missions, 
     #sometimes we have preexistent missions (!)
     return CountMissions(0,guildname)

def mission_lib.CreateRandomMission ( whichnum)

This function gets a random mission and saves the information in
an array as the which element. Returns the sprite file and text.

Definition at line 368 of file mission_lib.py.

References AddNewMission(), PickleTools.decodeMap(), getMissionPlayer(), MakeContraband(), MakePlunder(), vsrandom.random(), vsrandom.randrange(), dospath.split(), and locale.str().

 
 def CreateRandomMission(whichnum):
     """ This function gets a random mission and saves the information in
     an array as the which element. Returns the sprite file and text."""
     which = str(whichnum)
     missiontype = vsrandom.random();
     fac = VS.GetGalaxyFaction(VS.getSystemFile())
     if fac=="pirates":
         if (missiontype>.5):
             return None
         missiontype*=.2;
     elif (VS.GetRelation(fac,"pirates")<-.8 and missiontype<.1):
         missiontype = 0.1 + 0.9 * missiontype
     plr = getMissionPlayer()
     if (missiontype<.05):
         return MakePlunder(which)
     elif (missiontype<.1):
         return MakeContraband(which)
     else:
         goodlist = []
         for indx in range(Director.getSaveStringLength(plr, "mission_scripts")):
             script=Director.getSaveString(plr,"mission_scripts",indx)
             if script.find("#F#")!=-1:
                 goodlist.append(indx)
         goodlist.sort()
         goodlist.reverse()
         if len(goodlist):
             i = goodlist[vsrandom.randrange(len(goodlist))]
             script = Director.getSaveString(plr,"mission_scripts",i)
             desc = Director.getSaveString(plr,"mission_descriptions",i)
             vars = PickleTools.decodeMap( Director.getSaveString(plr,"mission_vars",i) )
             vars.setdefault('MISSION_SHORTDESC',Director.getSaveString(plr, "mission_names",i))
             Director.eraseSaveString(plr,"misson_scripts",i)
             Director.eraseSaveString(plr,"misson_descriptions",i)
             Director.eraseSaveString(plr,"misson_names",i)
             Director.eraseSaveString(plr,"misson_vars",i)
             mylist = script.split("#")  ###Skip the first two because first is always '' and second is always 'F'
             try:
                 vars['MISSION_ID'] = vars['MISSION_ID']
             except:
                 vars['MISSION_ID'] = which
             description = vars['MISSION_SHORTDESC'].split("/")[1]
             vars['MISSION_NAME'] = description
             AddNewMission(description,script,None,desc,mylist[4],vars,vars)
             return (mylist[2], mylist[3], which, description)
         else:
             # It should only get here if no fixer missions were found
             return None  # Fixer code will generate a NoFixer hopefully.

def mission_lib.GetMissionList ( activelist = True)

Returns a list of missions that were already generated.
With the activelist parameter, one can filter the active or
all missions.

Definition at line 306 of file mission_lib.py.

References getMissionPlayer().

 
 def GetMissionList(activelist=True):
     """ Returns a list of missions that were already generated.
     With the activelist parameter, one can filter the active or
     all missions.
     """
     plr = getMissionPlayer()
     active_missions = players[plr].active_missions
     last_briefing_vars = players[plr].last_briefing_vars
     last_briefing = players[plr].last_briefing
     
     if activelist:
         return active_missions
     else:
         return list( dict( list(last_briefing_vars[0][index].iteritems())+
             [('DESCRIPTION',last_briefing[0][index]),
                 ('ACCEPT_MESSAGE',last_briefing[1][index]),
                 ('MISSION_NAME',index)] )
             for index in last_briefing[0] )

def mission_lib.getMissionPlayer ( )

Definition at line 47 of file mission_lib.py.

 
 def getMissionPlayer():
     # Will allow to hardcode a player number in certain cases.
     if global_plr >= 0:
         return global_plr
     else:
         return VS.getCurrentPlayer()

def mission_lib.Jumplist ( jumps)

Definition at line 325 of file mission_lib.py.

References dospath.split().

 
 def Jumplist (jumps):
     if not len(jumps):
         return 'Your destination is this system.'
     str="First of all, you will need to fly to the %s jumppoint. "%jumps[0].split('/')[-1]
     for j in jumps[1:]:
         str+="Then jump in the %s jumppoint. "%j.split('/')[-1]
     return str

def mission_lib.LoadLastMission ( which = None)

Makes a mission an active mission.

Definition at line 115 of file mission_lib.py.

References debug.debug, debug.error, webbrowser.get(), getMissionPlayer(), RemoveLastMission(), custom.run(), and locale.str().

 
 def LoadLastMission(which=None):
     """ Makes a mission an active mission. """
     print "#given mission argument: ", which
     plr = getMissionPlayer()
     if which is None:
         which = str(players[plr].lastMission)
         print "#loading mission: ", which
     if VS.networked():
         custom.run('mission_lib', ['LoadLastMission',which], None)
         return
     
     last_constructor = players[plr].last_constructor
     last_args = players[plr].last_args
     last_briefing_vars = players[plr].last_briefing_vars
     last_briefing = players[plr].last_briefing
     ret = True
     if which in last_constructor and which in last_args:
         if last_constructor[which]==None:
             if type(last_args[which])==str:
                 script = "%(args)s"
             else:
                 script = "%(args)r()"
             vars = dict(args=last_args[which])
         else:
             script = '''#
 import %(constructor)s
 temp=%(constructor)s.%(constructor)s%(args)s
 mission_lib.AddMissionHooks(temp)
 temp=0
 '''
             cons=last_constructor[which]
             if type(cons)!=str:
                 cons=cons.__name__
             if type(last_args[which])==str:
                 args = last_args[which]
             else:
                 args = repr(last_args[which])
             vars = dict(constructor=cons,args=args)
         script = script % vars
         if script[:1] == '#':
             prescript = '''#
 import mission_lib
 mission_lib.SetMissionHookArgs(%(amentry)r)
 %(postscript)s'''
             amentry = last_briefing_vars[0].get(which,dict())
             try:
                 amentry.update(last_briefing_vars[1].get(which,dict()).iteritems())
                 amentry.update([
                     #('MISSION_NAME',which),
                     ('DESCRIPTION',last_briefing[0].get(which,'')),
                     ('ACCEPT_MESSAGE',last_briefing[1].get(which,'')) 
                     ])
             except:
                 debug.error("TRACING BACK")
                 import sys
                 debug.error(sys.exc_info()[0])
                 debug.error(sys.exc_info()[1])
                 debug.error("BACKTRACE done")
                 ret = False
             vars = dict(amentry=amentry,postscript=script)
             script = prescript % vars
         debug.debug("Loading mission:\n%s" % script)
         VS.LoadNamedMissionScript(which, script)
     else:
         debug.debug('No last mission with name "'+str(which)+'"')
         ret = False
     RemoveLastMission(which)
     return ret

def mission_lib.MakeContraband ( which)

Definition at line 349 of file mission_lib.py.

References AddNewMission(), universe.getAdjacentSystems(), Jumplist(), vsrandom.randrange(), and locale.str().

 
 def MakeContraband(which):
     constructor = cargo_mission.cargo_mission
     numsys=vsrandom.randrange(2,5)
     jumps=universe.getAdjacentSystems(VS.getSystemFile(),numsys)[1]
     diff=vsrandom.randrange(0,3)
     creds=numsys*2500+diff*800
     args = ('pirates', 0, 6, diff,creds, 1, 1200, 'Contraband',jumps)
     briefing0 = 'We need some...*cough*... cargo delivered to some of our pirates in a nearby system: '+ Jumplist(jumps)+ ' It\'d be preferable if ye kept the ole po\' off yo back durin the run. Will ya do it for '+str(creds)+' creds?'
     briefing1 = 'Thanks pal; keep it on the d&l if you know my meanin.'
     vars = { 'MISSION_TYPE' : 'CONTRABAND',
              'MISSION_SHORTDESC' : 'Deliver contraband to %s for %s' % (Jumplist(jumps),creds) }
     try:
         vars['MISSION_ID'] = vars['MISSION_ID']
     except:
         vars['MISSION_ID'] = which
     description = vars['MISSION_SHORTDESC']
     AddNewMission(description,args,constructor,briefing0,briefing1,vars,vars)
     return ("bases/fixers/pirate.spr","Talk with the Pirate",which)

def mission_lib.MakePlunder ( which)

Definition at line 333 of file mission_lib.py.

References AddNewMission(), vsrandom.randrange(), and locale.str().

 
 def MakePlunder(which):
     constructor = plunder.plunder
     creds=vsrandom.randrange(15,25)*1000
     args = (creds,'pirates',5,'Contraband',1)
     briefing0 = 'Arr Matey. We have a target in this system that needs a lil roughin up. We need you to bag a merchant and deliver her cargo into our hands.  It\'s worth '+str(creds)+ ' to us. Up to you, ya space pirate.'
     briefing1 = 'Ahoy! We\'ll be lookin for that cargo mighty soon!'
     vars = { 'MISSION_TYPE' : 'PIRACY',
              'MISSION_SHORTDESC' : 'Plunder merchant target for %s' % creds }
     try:
         vars['MISSION_ID'] = vars['MISSION_ID']
     except:
         vars['MISSION_ID'] = which
     description = vars['MISSION_SHORTDESC']
     AddNewMission(description,args,constructor,briefing0,briefing1,vars,vars)
     return ("bases/fixers/pirate.spr","Talk with the Pirate",which)

def mission_lib.mission_lib_custom	(	local,
		cmd,
		args,
		id
	)

Definition at line 60 of file mission_lib.py.

References custom.add(), AddNewMission(), CreateFixerMissions(), and LoadLastMission().

 
 def mission_lib_custom(local, cmd, args, id):
     if args[0] == 'AddNewMission':
         which = args[1]
         brief0 = args[2]
         brief1 = args[3]
         num_briefing_vars = int(args[4])
         briefing_vars = {}
         for i in range(num_briefing_vars):
             briefing_vars[args[i*2+5]] = args[i*2+6]
         AddNewMission(which, None, None, brief0, brief1, briefing_vars, briefing_vars)
     elif args[0] == 'LoadLastMission':
         which = args[1]
         LoadLastMission(which)
     elif args[0] == 'CreateFixerMissions':
         ret = CreateFixerMissions()
         vals = [0]
         for m in ret:
             if isinstance(m,tuple):
                 vals += m
                 vals[0] += 1
         return vals

def mission_lib.PickRandomMission ( goodlist)

Unused code – has old briefings if (searchMissionNameStr("patrol")): last_briefing[0][which] = 'Confed needs the help of mercs and hunters to keep our air space clean.

There are increasing reports of pirate and alien activity in these sectors and we need your sensor data. '+Jumplist(jumps) +' Will you do the patrol in said system for '+str(creds)+' credits?' if (searchMissionNameStr("cargo")): last_briefing[0][which] = 'Our business needs you to run some legit goods to a base a few systems away. '+ Jumplist(jumps) + ' This is worth '+str(creds)+' to us.' if (diff>=2): last_briefing[0][which]+=' However, you cannot fail us! There are consequences for your actions in this universe.' if (searchMissionNameStr("bounty")): last_briefing[0][which] = 'We need you to hit a nearby target. '+Jumplist(jumps)+' Our reward is '+str(creds)+' will you do it?' if (searchMissionNameStr("defend")): last_briefing[0][which] = 'We need help to secure a nearby strategic point in this system. Eliminate all enemies there. We offer '+str(encred)+' per enemy. Will you do it?' if (base): last_briefing[0][which] = 'One of our capitol vessels is under attack in this system! We call to the aid of all bounty hunters to defend it. Our reward is '+str(encred)+' per enemy craft destroyed. Will you help us?'

Definition at line 455 of file mission_lib.py.

References vsrandom.randrange().

 
 def PickRandomMission(goodlist):
     bounds = 0
     for mis in goodlist:
         bounds = bounds + mis[1]
     if bounds:
         pos = vsrandom.randrange(bounds)
         for midx in range(len(goodlist)):
             if pos>=goodlist[midx][1]:
                 pos = pos - goodlist[midx][1]
             else:
                 return midx
         return len(goodlist)-1
     else:
         return None
 
 # accepttypes is a dictionary that takes mission types as keys, and has
 # mission frequencies (likelihood of appearing) as values. A special key
 # is the asterisk ('*'), which is a wildcard key that applies to any other
 # key. If a mission's type cannot find a matching key (the wildcard matches
# all), then it will have frequency 0 (meaning, it will be disallowed).

def mission_lib.RemoveActiveMissionEntry ( entry_id)

Definition at line 210 of file mission_lib.py.

References fnmatch.filter(), and getMissionPlayer().

 
 def RemoveActiveMissionEntry(entry_id):
     plr = getMissionPlayer()
     players[plr].active_missions = filter(lambda x:x.get('ENTRY_ID',None)!=entry_id,
                     players[plr].active_missions)

def mission_lib.RemoveLastMission ( which = None)

Definition at line 184 of file mission_lib.py.

References getMissionPlayer().

 
 def RemoveLastMission(which=None):
     plr = getMissionPlayer()
     if which is None:
         which=players[plr].lastMission
     
     last_constructor = players[plr].last_constructor
     last_args = players[plr].last_args
     last_briefing_vars = players[plr].last_briefing_vars
     last_briefing = players[plr].last_briefing
     for container in (  last_args,last_constructor,
                         last_briefing[0],last_briefing[1],
                         last_briefing_vars[0],last_briefing_vars[1]  ):
         if which in container:
             del container[which]
     players[plr].lastMission=None

def mission_lib.SetLastMission ( which)

Definition at line 111 of file mission_lib.py.

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

 
 def SetLastMission(which):
     players[getMissionPlayer()].lastMission = str(which)
     debug.debug('set last mission to "'+str(which)+'"')

def mission_lib.SetMissionHookArgs ( args)

Definition at line 93 of file mission_lib.py.

References getMissionPlayer().

 
 def SetMissionHookArgs(args):
     players[getMissionPlayer()].hookargs = args

def mission_lib.setMissionPlayer ( plr = -1)

Definition at line 54 of file mission_lib.py.

 
 def setMissionPlayer(plr=-1):
     global global_plr

    global_plr = plr

def mission_lib.unsetMissionPlayer ( )

Definition at line 57 of file mission_lib.py.

References setMissionPlayer().

 
 def unsetMissionPlayer():
     setMissionPlayer(-1)

int global_plr = -1

Definition at line 45 of file mission_lib.py.

list players = []

Definition at line 20 of file mission_lib.py.

Data Structures
class	PlayerMissionInfo

class	missionhook

Data Structures

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation

Functions
def	addPlayer

def	getMissionPlayer

def	setMissionPlayer

def	unsetMissionPlayer

def	mission_lib_custom

def	SetMissionHookArgs

def	AddMissionHooks

def	SetLastMission

def	LoadLastMission

def	RemoveLastMission

def	AddActiveMissionEntry

def	RemoveActiveMissionEntry

def	CountMissions

def	BriefLastMission

def	AddNewMission

def	GetMissionList

def	Jumplist

def	MakePlunder

def	MakeContraband

def	CreateRandomMission

def	CreateFixerMissions

def	PickRandomMission
	Unused code – has old briefings if (searchMissionNameStr("patrol")): last_briefing[0][which] = 'Confed needs the help of mercs and hunters to keep our air space clean. More...

def	CreateGuildMissions