Vega strike Python Modules doc  0.5.1
Documentation of the " Modules " folder of Vega strike
 All Data Structures Namespaces Files Functions Variables
Public Member Functions | Data Fields
patrol Class Reference
Inheritance diagram for patrol:
patrol_enemies cleansweep cleansweep_escort

Public Member Functions

def __init__
 
def SuccessMission
 
def FailMission
 
def GeneratePatrolList
 
def DeletePatrolPoint
 
def FinishedPatrol
 
def Execute
 
def initbriefing
 
def loopbriefing
 
def endbriefing
 

Data Fields

 donevar
 
 jnum
 
 cred
 
 patrolpoints
 
 objectives
 
 distance
 
 you
 
 quantity
 
 mplay
 
 adjsys
 

Detailed Description

Definition at line 11 of file patrol.py.

Constructor & Destructor Documentation

def __init__ (   self,
  numsystemsaway,
  num_significants_to_patrol,
  distance_from_base,
  creds,
  jumps = (),
  donevar = '' 
)

Definition at line 12 of file patrol.py.

12 
13  def __init__ (self,numsystemsaway, num_significants_to_patrol, distance_from_base, creds, jumps=(), donevar=''):
14  Director.Mission.__init__(self)
15  self.donevar=donevar
16  self.jnum=0
17  self.cred=creds
18  self.patrolpoints = []
19  self.objectives = []
20  self.distance = distance_from_base
21  self.you = VS.getPlayer()
22  self.quantity=num_significants_to_patrol
23  name = self.you.getName ()
24  self.mplay=universe.getMessagePlayer(self.you)
25  VS.IOmessage (0,"patrol",self.mplay,"You must patrol a system for us :")
26  self.adjsys = go_to_adjacent_systems(self.you,numsystemsaway,jumps)
27  self.adjsys.Print("From the %s system,","Carefully go to %s.","You should shortly arrive in the %s: patrol it.","patrol",1)

Member Function Documentation

def DeletePatrolPoint (   self,
  num,
  nam 
)

Definition at line 75 of file patrol.py.

References patrol.jnum, escort_mission.mplay, defend.mplay, patrol.mplay, escort_local.mplay, bounty.mplay, directions_mission.mplay, cargo_mission.mplay, patrol.objectives, and patrol.patrolpoints.

75 
76  def DeletePatrolPoint (self,num,nam):
77  VS.IOmessage (0,"patrol",self.mplay,"[Computer] %s scanned, data saved..."%nam)
78  VS.setCompleteness(self.objectives[self.jnum],1.0)
79  self.you.commAnimation("scan_complete.ani")
80  del self.objectives[self.jnum]
del self.patrolpoints[self.jnum]
def endbriefing (   self)

Definition at line 110 of file patrol.py.

110 
111  def endbriefing(self):
print "ending briefing"
def Execute (   self)

Definition at line 94 of file patrol.py.

References patrol.FinishedPatrol(), patrol.GeneratePatrolList(), defend.quantity, patrol.quantity, escort_local.quantity, cargo_mission.quantity, cleansweep.SuccessMission(), patrol.SuccessMission(), defend.SuccessMission(), and escort_local.SuccessMission().

94 
95  def Execute (self):
96  if (self.you.isNull()):
97  VS.terminateMission(0)
98  return
99  if (self.adjsys.Execute()):
100  if (self.quantity>0):
101  self.GeneratePatrolList ()
102  else:
103  if (self.FinishedPatrol()):
104  self.SuccessMission()
def FailMission (   self)

Definition at line 36 of file patrol.py.

References patrol.cred, bounty.cred, defend.cred, escort_local.cred, cargo_mission.cred, patrol.donevar, escort_mission.mplay, defend.mplay, patrol.mplay, bounty.mplay, escort_local.mplay, directions_mission.mplay, cargo_mission.mplay, and quest.removeQuest().

36 
37  def FailMission (self):
38  self.you.addCredits (self.cred)
39  if self.donevar!='':
40  quest.removeQuest(self.you.isPlayerStarship(),self.donevar,-1)
41  VS.IOmessage (0,"patrol",self.mplay,"Mission a failure!")
42  VS.terminateMission(0)
def FinishedPatrol (   self)

Definition at line 81 of file patrol.py.

References cleansweep.DeletePatrolPoint(), cleansweep_escort.DeletePatrolPoint(), patrol.DeletePatrolPoint(), patrol.distance, unit.getUnitFullName(), patrol.jnum, and patrol.patrolpoints.

81 
82  def FinishedPatrol (self):
83  if (self.jnum<len(self.patrolpoints)):
84  jpoint =self.patrolpoints[self.jnum]
85  if (jpoint.isNull()):
86  self.DeletePatrolPoint(self.jnum,"Debris")
87  else:
88  if (self.you.getSignificantDistance (jpoint)<self.distance):
89  self.DeletePatrolPoint(self.jnum,unit.getUnitFullName(jpoint))
90  else:
91  self.jnum+=1
92  else:
93  self.jnum=0
return (len(self.patrolpoints)==0)
def GeneratePatrolList (   self)

Definition at line 43 of file patrol.py.

References patrol.distance, unit.getUnitFullName(), escort_mission.mplay, defend.mplay, patrol.mplay, escort_local.mplay, bounty.mplay, directions_mission.mplay, cargo_mission.mplay, patrol.objectives, patrol.patrolpoints, patrol.quantity, defend.quantity, escort_local.quantity, cargo_mission.quantity, vsrandom.randrange(), universe.significantUnits(), escort_mission.you, patrol.you, directions_mission.you, go_to_adjacent_systems.you, bounty.you, defend.you, escort_local.you, and cargo_mission.you.

43 
44  def GeneratePatrolList (self):
45  VS.IOmessage (0,"patrol",self.mplay,"You must get within %f klicks of" % self.distance)
46  count=self.quantity*6
47  str=""
48  import universe
49  self.patrolpoints=universe.significantUnits()
50  while (len(self.patrolpoints)>self.quantity and len(self.patrolpoints)):
51  del self.patrolpoints[vsrandom.randrange(0,len(self.patrolpoints))]
52  for sig in self.patrolpoints:
53  self.quantity=self.quantity-1
54  fac =sig.getFactionName()
55  nam =unit.getUnitFullName(sig)
56  enam =unit.getUnitFullName(sig,True)
57  sig.setMissionRelevant()
58  if (fac!="neutral"):
59  obj=VS.addObjective ("Scan %s"%nam)
60  VS.IOmessage (0,"patrol",self.mplay,"%s owned %s " % (fac,enam))
61  else:
62  if (sig.isPlanet()):
63  nam =unit.getUnitFullName(sig)
64  if (sig.isJumppoint()):
65  obj=VS.addObjective ("Scan Jumppoint %s" % nam)
66  else:
67  obj=VS.addObjective ("Scan %s" % nam)
68  else:
69  obj=VS.addObjective ("Scan Natural Phenomenon: %s" % nam)
70  VS.IOmessage (0,"patrol",self.mplay,"The object %s " % enam)
71  VS.setOwner(int(obj),self.you)
72  VS.setCompleteness(int(obj),0.0)
73  self.objectives+=[int(obj)]
74  self.quantity=0
def initbriefing (   self)

Definition at line 105 of file patrol.py.

105 
106  def initbriefing(self):
print "ending briefing"
def loopbriefing (   self)

Definition at line 107 of file patrol.py.

107 
108  def loopbriefing(self):
109  print "loop briefing"
Briefing.terminate();
def SuccessMission (   self)

Definition at line 28 of file patrol.py.

References patrol.cred, bounty.cred, defend.cred, escort_local.cred, cargo_mission.cred, patrol.donevar, escort_mission.mplay, defend.mplay, patrol.mplay, bounty.mplay, escort_local.mplay, directions_mission.mplay, cargo_mission.mplay, and quest.removeQuest().

28 
29  def SuccessMission (self):
30  self.you.addCredits (self.cred)
31  if self.donevar!='':
32  quest.removeQuest(self.you.isPlayerStarship(),self.donevar,1)
33  VS.IOmessage (0,"computer",self.mplay,"[Computer] Transmitting Data..")
34  VS.IOmessage (0,"patrol",self.mplay,"Thank you! Patrol Complete.")
35  VS.IOmessage (0,"patrol",self.mplay,"We have credited your account.")
VS.terminateMission(1)

Field Documentation

adjsys

Definition at line 25 of file patrol.py.

cred

Definition at line 16 of file patrol.py.

distance

Definition at line 19 of file patrol.py.

donevar

Definition at line 14 of file patrol.py.

jnum

Definition at line 15 of file patrol.py.

mplay

Definition at line 23 of file patrol.py.

objectives

Definition at line 18 of file patrol.py.

patrolpoints

Definition at line 17 of file patrol.py.

quantity

Definition at line 21 of file patrol.py.

you

Definition at line 20 of file patrol.py.

The documentation for this class was generated from the following file: