Changes between Version 2 and Version 3 of pps/tutorial_basic

Timestamp:

Sep 28, 2008, 10:54:51 PM (17 years ago)

Author:

rgrieder

Comment:

—

pps/tutorial_basic

@@ -36 +36 @@
 '''Now we extend the Ship'''
 As you might have recognized some features of the Ship were missing:
- * You can't fire (quite limitating)
- * ...
-In order to change this there are a few steps required:
- 1. Open the files TutorialShip.cc and TurorialShip.h (in trunk/src/orxonox/objects) with your favorite IDE or console
- 2. (???)
- 3. ...
- 4. Now edit the levelfile ( Media/levels/sample.oxw ) to use TutorialShip instead of !SpaceShip instead
-   - find the line where the the !SpaceShip gets loaded
-   - change !SpaceShip to TutorialShip
-   - add the new parameters (???)
-   - save and close the levelfile
+ * No special effects
+ * You can't fire in continuous mode
+
+== TutorialShip Class ==
+We have derived a new type of SpaceShip for you: TutorialShip. The back end doesn't have to bother you (you will notice that some functions don't seem to be doing anything at all). [[br]]
+At the moment, you are using the SpaceShip class. We would like to change this. Fortunately this can be done in an XML file where we load the level.
+ 1. Go to your media repository (orxonox/Media) and open ''tutorial.oxw'' in the ''level'' folder with a text editor like vim, nano, etc.
+ 1. Find the second paragraph (about 5th line) and change ''SpaceShip'' to ''TutorialShip''
+ 1. Save the file. You can keep it open, we need it again later.
+Next thing will be to change the code accordingly, since the game will probably crash now when started. [[br]]
+We organise our source files via CMake as you have already found out. You now have to tell CMake to also compile the ''TutorialShip'':
+ 1. Open orxonox/trunk/src/orxonox/CMakeLists.txt
+ 1. You will see a large list of source files (*.cc). You can add "TutorialShip.cc" anywhere you like, but it is preferred to organise the file a little bit. So look for SpaceShip.cc and add things there.
+ 1. Save and close.
+The interesting part: Modifying the C++ code. '''Open orxonox/trunk/src/orxonox/objects/TutorialShip.cc'''. As you have already heard from Fabian, the Core Framework is like a language extension to C++. But it cannot be 100% automatic. That means you have to add a few lines accordingly:
+ 1. Find the constructor (TutorialShip::TutorialShip()) and add '''RegisterObject(TutorialShip)''' as the first statement. This is used for the class hierarchy and for the ObjectLists.
+ 1. do more stuff
+ 1. (???)
+ 1. ...
+
 '''Now start the game again and do some fancy in-game-stuff'''
  1. (???)