Fixes #140 Extra Discovery Quest Options

Can not require a home base now
Can also turn off missions

Author: hawkerm

SBA_Serv/Game/DiscoveryQuest.py

@@ -48,6 +48,8 @@ def __init__(self, cfgobj):
 
         super(DiscoveryQuestGame, self).__init__(cfgobj)
 
+        self.mustbase = cfgobj.getboolean("DiscoveryQuest", "establish_homebase")
+        self.usemissions = cfgobj.getboolean("DiscoveryQuest", "missions")
         self._missions = cfgobj.get("DiscoveryQuest", "mission_objectives").split(",")
         self.scantime = cfgobj.getfloat("DiscoveryQuest", "scan_time")
         self.scanrange = cfgobj.getint("DiscoveryQuest", "scan_range")
@@ -58,22 +60,23 @@ def game_get_info(self):
         return {"GAMENAME": "DiscoveryQuest"}
 
     def player_reset_mission(self, player):
-        # get a number of missions for each thing
-        player.mission = []
-        player.scanned = []
-        player.failed = False
-        for i in xrange(cfg_rand_min_max(self.cfg, "DiscoveryQuest", "mission_num")):
-            player.mission.append(random.choice(self._missions)) # TODO: validate that this player can still scan those types of objects
+        if self.usemissions:
+            # get a number of missions for each thing
+            player.mission = []
+            player.scanned = []
+            player.failed = False
+            for i in xrange(cfg_rand_min_max(self.cfg, "DiscoveryQuest", "mission_num")):
+                player.mission.append(random.choice(self._missions)) # TODO: validate that this player can still scan those types of objects
 
     def player_added(self, player, reason):
         if reason == BasicGame._ADD_REASON_REGISTER_:
-            player.buffervalue = 0
-            player.outpost = None
-            player.lastids = []
+            player.buffervalue = 0 # stored points before scanning first output, if outpost is required.
+            player.outpost = None # home base obj
+            player.lastids = [] # last ids scanned
 
-        player.mission = []
-        player.scanned = []
-        player.failed = True
+        player.mission = [] # List of strings of items to scan
+        player.scanned = [] # ids scanned by player
+        player.failed = True # whether current mission has failed, starts as true as no mission to start
 
         return super(DiscoveryQuestGame, self).player_added(player, reason)
 
@@ -129,6 +132,9 @@ def world_add_remove_object(self, wobj, added):
             opt = "points_" + friendly_type(wobj).lower()
             if self.cfg.has_option("DiscoveryQuest", opt):
                 wobj.value = self.cfg.getint("DiscoveryQuest", opt)
+            else:
+                #guard
+                wobj.value = 0
 
         return super(DiscoveryQuestGame, self).world_add_remove_object(wobj, added)
 
@@ -210,7 +216,7 @@ def dq_finished_scan(self, ship, obj, success):
                     ship.player.buffervalue = 0
                     ship.player.sound = "SUCCESS"
 
-                if not ship.player.failed and len(ship.player.mission) == 0: # completed mission exactly
+                if self.usemissions and not ship.player.failed and len(ship.player.mission) == 0: # completed mission exactly
                     points = 0
                     # tally points of scanned objects
                     for obj in ship.player.scanned:
@@ -233,7 +239,7 @@ def dq_finished_scan(self, ship, obj, success):
                 # update scores
                 obj.scanned_by.append(ship.player)
                 ship.player.sound = "SUCCESS"
-                if ship.player.outpost != None:                    
+                if ship.player.outpost != None or not self.mustbase: # or we don't require bases for points
                     ship.player.update_score(obj.value)
                 else: #haven't found outpost, need to buffer points
                     ship.player.buffervalue += obj.value
@@ -245,8 +251,9 @@ def gui_draw_game_world_info(self, surface, flags, trackplayer):
             if obj != None:
                 bp = intpos(obj.body.position)
                 wrapcircle(surface, (0, 255, 255), bp, self.scanrange, self.world.size, 1) # Scan Range
-                text = debugfont().render("%s [%s]" % (repr(player.mission), player.failed), False, (0, 255, 255))
-                surface.blit(text, (bp[0]-text.get_width()/2, bp[1] - 6))
+                if self.usemissions:
+                    text = debugfont().render("%s [%s]" % (repr(player.mission), player.failed), False, (0, 255, 255))
+                    surface.blit(text, (bp[0]-text.get_width()/2, bp[1] - 6))
 
         if trackplayer != None:
             curs = []

SBA_Serv/game_discoveryquest.cfg

@@ -47,10 +47,12 @@ secondary_victory_attr = buffervalue
 secondary_victory_highest = true
 
 [DiscoveryQuest]
+establish_homebase = true
 scan_time = 3.5
 scan_range = 150
 ship_spawn_dist = 105
 disable_warp_in_nebula = true
+missions = true
 mission_objectives = Asteroid,Planet,BlackHole,Nebula,Star,Outpost,WormHole
 mission_num_min = 1
 mission_num_max = 3

doc/games/discoveryquest.md

@@ -15,19 +15,22 @@ Discovery Quest
 -----------
 **Discovery Quest** is an exploration game where players must navigate space in order to 'scan' objects and accumulate points.  They establish a research **Outpost** which can also provide them with specific missions for additional points.
 
-Players must establish an **Outpost** by scanning it before any points will count towards their placement within the game.  Any points earned prior to establishing an Outpost will be banked and awarded when an Outpost is first established. (Multiple players may establish and share the same Outpost.)  An established Outpost's location can be later retrieved with the *getObjectiveLocation()* method of the environment's getGameInfo().
+Players must establish an **Outpost** by scanning it before any points will count towards their placement within the game.  Any points earned prior to establishing an Outpost will be banked and awarded when an Outpost is first established. (Multiple players may establish and share the same Outpost.)  An established Outpost's location can be later retrieved with the *getObjectiveLocation()* method of the environment's getGameInfo().  *This can be turned off with configuration such that any objects scanned will receive points.*
 
 *Scanning* is a specific command that must be used within 150 pixels of an object and must be directed towards a specific object by using its ID number.  Scanning is **not** the same as Radar.  The object being scanned must remain in range for the entire duration of the scan.
 
-A **Mission** dictates which objects a ship should go scan.  If a ship goes and scans ONLY those things, bonus points will be awarded when they return to their outpost and Scan it again.  Scanning your Outpost will always give you a new mission.
+A **Mission** dictates which objects a ship should go scan.  If a ship goes and scans ***ONLY*** those things, bonus points will be awarded when they return to their outpost and Scan it again.  Scanning your Outpost will always give you a new mission.  **Note:** the first Outpost you scan becomes your base and is the only Outpost you can receive and complete missions from.  (Other Outposts may still be scanned for points or mission objectives.)
 
 Your Ship being destroyed clears/fails your mission, so you must return to your established Outpost if you want a new one.
 
-Discovery Quest prevents warping out of Nebulas.
+**NOTE: Discovery Quest prevents warping out of Nebulas, unless turned off in configuration.**
 
 
 <a name="config"></a>Configuration
 -----------
+###establish_homebase = boolean
+Whether or not the player must scan an Outpost first in order to start banking points. When off, all points scanned will count, Outposts can still be scanned for points and bonus missions if missions are enabled (see below).
+
 ###scan_time = float
 Amount of time required to complete a successful scan in seconds. (3.5 default)
 
@@ -40,6 +43,9 @@ Maximum distance a ship will spawn away from an Outpost.
 ###disable_warp_in_nebula = boolean
 Set to prevent players from Warping out of Nebulas. (true default)
 
+###missions = boolean
+Whether or not missions can be obtained from scanning outposts.
+
 ###mission_objectives = string
 Comma separated list of object types which can appear within Missions.
 
@@ -77,4 +83,7 @@ Number of points a Dragon is worth when successfully scanned. (6 default)
 Number of points a Worm Hole is worth when successfully scanned. (2 default)
 
 ###points_ship = int
-Number of points another Ship is worth when successfully scanned. (4 default)
+Number of points another Ship is worth when successfully scanned. (4 default)
+
+###points_spacemine = int
+Number of points a Space Mine is worth when successfully scanned. (8 default)