Vega strike Python Modules doc  0.5.1
Documentation of the " Modules " folder of Vega strike
 All Data Structures Namespaces Files Functions Variables
ShowProgress Namespace Reference

Functions

def activateProgressScreen
 
def activeProgressScreen
 
def showingProgressScreen
 
def deactivateProgressScreen
 
def setProgressMessage
 
def setProgressBar
 

Variables

tuple __active = set()
 
 __showing = None
 
int __delay = 0
 

Function Documentation

def ShowProgress.activateProgressScreen (   screen_id,
  delay = 0,
  force = False 
)

Definition at line 8 of file ShowProgress.py.

8 
9 def activateProgressScreen(screen_id,delay=0,force=False):
10  # Sometimes we have to force it, because VS engine forceably unloads some splash screens at the very start.
11  global __active, __showing, __delay
12  if screen_id not in __active or force:
13  __active.add(screen_id)
14  if True:
15  screen = VS.vsConfig("splash","%s_sprite" % screen_id,"")
16  message = VS.vsConfig("splash","%s_message" % screen_id,"")
17  screensplit = screen.split(" ")
18  screen = screensplit[vsrandom.randrange(0,len(screensplit))]
19  if screen != "" or message != "":
20  __showing = screen_id
21  __delay = delay
22  VS.showSplashScreen(screen)
23  VS.showSplashMessage(message)
def ShowProgress.activeProgressScreen (   screen_id)

Definition at line 24 of file ShowProgress.py.

24 
25 def activeProgressScreen(screen_id):
26  global __active
27  return screen_id in __active
def ShowProgress.deactivateProgressScreen (   screen_id)

Definition at line 35 of file ShowProgress.py.

References activateProgressScreen().

35 
36 def deactivateProgressScreen(screen_id):
37  global __active, __showing, __delay
38  if screen_id in __active:
39  if screen_id != __showing or __delay == 0:
40  __active.remove(screen_id)
41  else:
42  __delay -= 1
43  return
44  for screen_id in __active:
45  activateProgressScreen(screen_id)
46  return
47  VS.hideSplashScreen()
48  __showing = None
def ShowProgress.setProgressBar (   screen_id,
  progress 
)

Definition at line 57 of file ShowProgress.py.

57 
58 def setProgressBar(screen_id,progress):
59  global __showing
60  if screen_id == __showing:
61  VS.showSplashProgress(progress)
62 
def ShowProgress.setProgressMessage (   screen_id,
  message 
)

Definition at line 49 of file ShowProgress.py.

49 
50 def setProgressMessage(screen_id,message):
51  global __showing
52  if screen_id == __showing:
53  prefix = VS.vsConfig("splash","%s_message" % screen_id,"")
54  if prefix != "":
55  prefix += ": "
56  VS.showSplashMessage(prefix+message)
def ShowProgress.showingProgressScreen (   screen_id = None)

Definition at line 28 of file ShowProgress.py.

28 
29 def showingProgressScreen(screen_id=None):
30  global __showing
31  if screen_id is None:
32  return __showing
33  else:
34  return __showing == screen_id

Variable Documentation

tuple __active = set()

Definition at line 4 of file ShowProgress.py.

int __delay = 0

Definition at line 6 of file ShowProgress.py.

__showing = None

Definition at line 5 of file ShowProgress.py.