HowTo:Edit Missions:XML integration - Revision history

Nabaco: Switched SVN URLs to GH

2020-03-22T17:27:03Z

Switched SVN URLs to GH

Tbeholder at 13:05, 9 February 2014

2014-02-09T13:05:38Z

Tbeholder at 13:04, 9 February 2014

2014-02-09T13:04:15Z

Tbeholder at 11:33, 9 February 2014

2014-02-09T11:33:12Z

Legine: Undo revision 16809 by Legine (Talk)

2009-02-22T15:53:30Z

Undo revision 16809 by Legine (Talk)

Legine: /* Python Section */

2009-02-22T15:51:03Z

‎Python Section

Ace123: /* Python Section */ Fixed indentation in missions page.

2009-02-22T00:05:09Z

‎Python Section: Fixed indentation in missions page.

pyramid at 14:08, 21 April 2008

2008-04-21T14:08:41Z

pyramid at 09:06, 21 April 2008

2008-04-21T09:06:11Z

Pirx at 18:30, 28 May 2005

2005-05-28T18:30:01Z

@@ Line 1: / Line 1: @@
 ==Basic XML integration==
-First let me start by explaining how to run a python class... in this case we start with the prebuild <code>[http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/modules/missions/privateer.py modules/missions/privateer.py]</code> script to run our mission. Open up <code>[http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/mission/explore_universe.mission mission/explore_universe.mission]</code> First come the variables that designate how the mission should normally start. By normally I mean if they don't have any save game present.
+First let me start by explaining how to run a python class... in this case we start with the prebuild <code>[https://github.com/vegastrike/Assets-Production/blob/master/modules/missions/privateer.py modules/missions/privateer.py]</code> script to run our mission. Open up <code>[https://github.com/vegastrike/Assets-Production/blob/master/mission/explore_universe.mission mission/explore_universe.mission]</code> First come the variables that designate how the mission should normally start. By normally I mean if they don't have any save game present.
 ===Variables Section===
@@ Line 54: / Line 54: @@
 *** "hornet.xunit" (default) {{fixme}}
 ** '''ainame''' [string] [needed] - AI to use.
-*** Much like <code>data/ai/VegaEvents.csv</code>: it refers to <code>[http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/ai/events/ data/ai/events/]'''ainame'''.*.xml</code> AI files, ''not'' .xai scripts they call.
+*** Much like <code>data/ai/VegaEvents.csv</code>: it refers to <code>[https://github.com/vegastrike/Assets-Production/tree/master/ai/events data/ai/events/]'''ainame'''.*.xml</code> AI files, ''not'' .xai scripts they call.
-*** "_ainame" - {{fixme}} Seems to use Python [http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/modules/ai/ AI modules].
+*** "_ainame" - {{fixme}} Seems to use Python [https://github.com/vegastrike/Assets-Production/tree/master/modules/ai/ AI modules].
 ** '''waves''' [int] [needed] - Number of waves. The next one will be launched only after its predecessor is completely eliminated.
 ** '''nr_ships''' [int] [needed] - Ships per wave.
@@ Line 89: / Line 89: @@
 Future note: If you wanted to add a campaign to the privateer mission you would most likely modify <code>privateer.py</code> to have a campaign module get loaded.... so you wouldn't necessarily need to modify <code>explore_universe.mission</code> just to add a campaign... lets dig further into the meat of the scripting.
-If a mission has python tags...then it is a python mission and may have some embedded python in it. In this case the python makes a new python object of type privateer in the <code>privateer.py</code> module in the <code>[http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/modules/missions/ modules/missions/]</code> directory.
+If a mission has python tags...then it is a python mission and may have some embedded python in it. In this case the python makes a new python object of type privateer in the <code>privateer.py</code> module in the <code>[https://github.com/vegastrike/Assets-Production/blob/master/modules/missions/ modules/missions/]</code> directory.

@@ Line 64: / Line 64: @@
 * <code>pos</code> [double] [needed], <code>rot</code> [float] - Coordinates and orientation.
 ** '''x''', '''y''', '''z''' [float]
-* <code>order</code> - Scripted orders for the flightgroup. Seems to be read, but not actually parsed currently. {{fixme}} Flightgroups spawn with "fire at will" directive and start acting as their AI setups and AI priorities suggest.
+* <code>order</code> - Scripted orders for the flightgroup. Elements are read, but seems to not being actually parsed currently. {{fixme}} Flightgroups spawn with "fire at will" directive and start acting as their AI setups and AI priorities suggest.
 ** '''order''' [needed]
 ** '''target''' [needed] - The name of target flightgroup.

@@ Line 1: / Line 1: @@
 ==Basic XML integration==
-First let me start by explaining how to run a python class... in this case we start with the prebuild <code>[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/modules/privateer.py?rev=HEAD&content-type=text/vnd.viewcvs-markup modules/privateer.py]</code> script to run our mission. Open up <code>[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/mission/explore_universe.mission?rev=HEAD&content-type=text/vnd.viewcvs-markup mission/explore_universe.mission]</code> First come the variables that designate how the mission should normally start. By normally I mean if they don't have any save game present.
+First let me start by explaining how to run a python class... in this case we start with the prebuild <code>[http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/modules/missions/privateer.py modules/missions/privateer.py]</code> script to run our mission. Open up <code>[http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/mission/explore_universe.mission mission/explore_universe.mission]</code> First come the variables that designate how the mission should normally start. By normally I mean if they don't have any save game present.
 ===Variables Section===
@@ Line 54: / Line 54: @@
 *** "hornet.xunit" (default) {{fixme}}
 ** '''ainame''' [string] [needed] - AI to use.
-*** Much like <code>data/ai/VegaEvents.csv</code>: it refers to <code>data/ai/events/'''ainame'''.*.xml</code> AI files, ''not'' .xai scripts directly.
+*** Much like <code>data/ai/VegaEvents.csv</code>: it refers to <code>[http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/ai/events/ data/ai/events/]'''ainame'''.*.xml</code> AI files, ''not'' .xai scripts they call.
-*** "_ainame" - {{fixme}} Seems to use Python AI module.
+*** "_ainame" - {{fixme}} Seems to use Python [http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/modules/ai/ AI modules].
 ** '''waves''' [int] [needed] - Number of waves. The next one will be launched only after its predecessor is completely eliminated.
 ** '''nr_ships''' [int] [needed] - Ships per wave.
 ** '''terrain_nr'''
-*** ""; "mission"
+*** "" (default); "mission"
 ** '''unit_type'''
 *** "" (default) ='''unit'''; "vehicle"; "building"
 * <code>pos</code> [double] [needed], <code>rot</code> [float] - Coordinates and orientation.
-** '''x''', '''y''', '''z''' [float] [needed]
+** '''x''', '''y''', '''z''' [float]
-* <code>order</code> - Scripted orders for the flightgroup. Seems to be read, but not actually parsed currently. {{fixme}} Flightgroups spawn with "fire at will" directive and then start acting as their AI setups and AI priorities suggest.
+* <code>order</code> - Scripted orders for the flightgroup. Seems to be read, but not actually parsed currently. {{fixme}} Flightgroups spawn with "fire at will" directive and start acting as their AI setups and AI priorities suggest.
 ** '''order''' [needed]
 ** '''target''' [needed] - The name of target flightgroup.
@@ Line 89: / Line 89: @@
 Future note: If you wanted to add a campaign to the privateer mission you would most likely modify <code>privateer.py</code> to have a campaign module get loaded.... so you wouldn't necessarily need to modify <code>explore_universe.mission</code> just to add a campaign... lets dig further into the meat of the scripting.
-If a mission has python tags...then it is a python mission and may have some embedded python in it. In this case the python makes a new python object of type privateer in the <code>[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/modules/privateer.py?rev=HEAD&content-type=text/vnd.viewcvs-markup privateer.py]</code> module in the <code>[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/modules/ modules]</code>  directory.
+If a mission has python tags...then it is a python mission and may have some embedded python in it. In this case the python makes a new python object of type privateer in the <code>privateer.py</code> module in the <code>[http://sourceforge.net/p/vegastrike/code/HEAD/tree/trunk/data/modules/missions/ modules/missions/]</code> directory.

@@ Line 3: / Line 3: @@
 ===Variables Section===
-Notice that so far there are a lot of values you don't see for long in the default vegastrike game. Credits, System, first flightgroup fighter, difficulty--these are all initial values but can change.... since there is specified a savegame. The savegame makes the mission more of a campaign type mission where things may be saved to disk and reloaded at a later point.  If no savegame variable is specified (this is where the autosave goes) then the mission will not save and will be a one time play mission.
+* '''continuousterrain''' [string]
 <pre>
@@ Line 24: / Line 40: @@
 	</variables>
 </pre>
 ===Flightgroup Section===
-The <code>rot</code> flag is ignored, and the position specifies the <code>x,y,z</code> coords of the Shlimazel flightgroup, which is of type <code>llama.begin</code>.
 <pre>
@@ Line 43: / Line 83: @@
          </flightgroups>
 </pre>
 ===Python Section===
@@ Line 58: / Line 100: @@
 </pre>
-You have to be careful about newlines, etc in the XML, but it shoudl usually work just dandy. You notice that the mission may pass in arguments to the privateer module that can make slight changes in the gameplay. This allows many cargo missions to use the same module in order to change the parameters of the cargo missions. In this case the values I have selected appear to work relatively well.
+You have to be careful about newlines, etc in the XML, but it should usually work just dandy. You notice that the mission may pass in arguments to the privateer module that can make slight changes in the gameplay. This allows many cargo missions to use the same module in order to change the parameters of the cargo missions. In this case the values I have selected appear to work relatively well.
 Note: Python code must be on a line by itself without any indentations--it needs to work exactly as it would if you had the contents in a python file itself. If you want the indents to work in-line with the XML file, you must prefix it with a block, such as an if statement:

@@ Line 64: / Line 64: @@
 <pre>
 	<python>if 1:
-from privateer import privateer
+             from privateer import privateer
-my_obj=privateer(8000,40000,500,3,2,.6,.25,.1,400000,2000)
+             my_obj=privateer(8000,40000,500,3,2,.6,.25,.1,400000,2000)
 	</python>
 </mission>

@@ Line 1: / Line 1: @@
 {{NAV_Manual |
 | previous=[[HowTo:Add_Conversations|Add Conversations]]
-| up=[[HowTo:Edit Missions|Edit Missions]]
+| up=[[Development:Missions|Edit Missions]]
 | next=[[HowTo:Edit Missions:Python:Missions|Python Inheritance]]
 }}
@@ Line 70: / Line 70: @@
 {{NAV_Manual |
 | previous=[[HowTo:Add_Conversations|Add Conversations]]
-| up=[[HowTo:Edit Missions|Edit Missions]]
+| up=[[Development:Missions|Edit Missions]]
 | next=[[HowTo:Edit Missions:Python:Missions|Python Inheritance]]
 }}
 [[Category:HowTos|Edit Missions:XML integration]]
 [[Category:Development|Edit Missions:XML integration]]