Development:Quests - Revision history

Nikai: sp, update

2010-09-06T14:44:09Z

sp, update

2008-04-22T16:07:07Z

‎Quest Content

2008-04-22T10:18:32Z

‎Quest Content

2008-04-22T08:31:51Z

‎Quest Content

2008-04-22T07:50:52Z

‎Getting Units

2008-04-21T15:27:03Z

‎Getting Units

2008-04-21T15:22:24Z

‎Getting Properties

2008-04-21T15:18:04Z

‎Getting Objects

2008-04-21T14:18:15Z

‎See also

2008-04-21T13:02:30Z

@@ Line 1: / Line 1: @@
 =Writing Quests and Adventures=
-This page explains the structure of a quest file, it's integration and internal workings and is useful for campaign/mission/quest programmers.
+This page explains the structure of a quest file, its integration and internal workings and is useful for campaign/mission/quest programmers.
 A quest is the same as an adventure and is a series of events that happen around the player when he is in a specific system. Quests can be run independently of campaigns or missions, though they can also be part of them. It is a miniature mission that gets triggered by a player who goes into the system in which the quest is defined. A quest may either be persistent or non-persistent. A persistent quest will reload the next time the triggering player launched it until the player beats the mission.
@@ Line 9: / Line 9: @@
 =Quest Framework=
-The python code for quests resides in the directory ''data4.x/modules''.
+The python code for quests resides in the directory ''data/modules''.
 ==The "QUEST" Class: The Actual Quest Logic==

@@ Line 104: / Line 104: @@
 =Quest Content=
-Most of the python bindings (to the c++ engine) are listed in <code>data4.x/modules/stub/VS.py</code> and commented in [[HowTo:Edit_Missions:Python:Bindings:Python]].
+Since the Execute() function is called in each every frame, I want to discuss some useful ways to control when things should happen in your quest.
-There are many other useful functions coded in python and distributed through various other classes.
+==Controlling the Flow==
 =Sample Quests=

@@ Line 118: / Line 118: @@
 ==Getting Units==
-In the script you will require to reference the objects of the universe. Here are some examples to get you started:
+In the script you will require to reference the ships and other objects of the universe. Here are some examples to get you started:
 * <code>self.player = VS.getPlayer()</code> - that's you
 * <code>self.planet = unit.getUnitByName('Atlantis')</code> - get planet Atlantis
@@ Line 136: / Line 136: @@
 * <code>vec = self.player.Position()</code> - assign the player's position vector to a variable
 * <code>self.vessel.getName()</code> - gets the unit name, e.g. "Llama"
 ==System Properties==
@@ Line 174: / Line 175: @@
 ==Flight Groups==
-You can use "flightgroup directives" to give units specific orders (which is cool if you want to generate two drones and make one blow up another). The list of directives is in C++ (undocumented).
 A capital letter overrides the AI script, while a lower case letter will allow it to be changed. You can also add a "." to the end to ensure that the unit will not change targets on its own.

@@ Line 113: / Line 113: @@
 * <code>data4.x/modules/faction_ships.py</code> allows for a fine creation of ship lists by type and faction, e.g. for spawning.
 Some of the functions that might be of help when writing quests and adventures will be discussed further down.
 ==Getting Units==
@@ Line 129: / Line 132: @@
 ==Unit Properties==
 Once you have referenced the appropriate object, you want to get information about it. Again, some commented examples follow:
 * <code>self.planet.isDocked(self.player)</code> - verify if the player is docked to the planet. Note that you need to 'read' the meaning from right to left in this case.
 * <code>self.station.getDistance(self.player)</code> - The distance to the center of an object. Note that when landed on a planet, the distance is the actual planet radius.
 * <code>vec = self.player.Position()</code> - assign the player's position vector to a variable
 ==System Properties==

@@ Line 120: / Line 120: @@
 * <code>self.station = unit.getUnitByName('MiningBase')</code> - get the mining base
 * <code>self.object = unit.getUnitByName('Jump_To_Nethuuleil')<code> - get the jump point
-* <code>self.vessel= unit.getUnitByName('Ox')</code> - get an Ox ship
+* <code>self.vessel = unit.getUnitByName('Ox')</code> - get an Ox ship
 * <code>self.gf = VS.launch("Charlotte the Harlot","Robin","privateer","unit","default",1,1,(1000,10,3000),'')</code> - creates one ship of type "Robin", being of the faction "privateer", at position (1000,10,3000), which will behave like "default" and show up in the HUD as "Charlotte the Harlot"
 * <code>ships = VS.getUnitList()</code> - get a list of all objects in the current system
 * <code>self.jump = universe.getRandomJumppoint()</code> - get a random jump point
 ==Unit Properties==

@@ Line 186: / Line 186: @@
      self.aggressor.setFgDirective("A.")
 </pre></code>
 =See also=