Mission Type Objects

Download Code File

I have created this tutorial as I have often seen users of TGE getting frustrated over this. This is a very differnet way to set up TGE but I find it is a LOT easier to handle all forms of scripting in this manner, especially when the game requires multiple game types.

This tutorial contains files that can be placed into a raw HEAD (28/1/03) which will set the scripts up to use object oriented game type code. When you load up the game it will "seem" exactly the same except for the comment in the console telling you it has loaded some game code.

Anyway, heres the tutorial. Hope it helps some people

This tutorial contains the following files, all of which are compatible with 
the TGE CVS HEAD as of this date.

FILES:
	game.cs
	defaultGame.cs
	DMGame.cs
	CTFGame.cs
	

	WARNING!!!!  BEFORE YOU GO FURTHER BACK UP ALL OF YOUR FILES!!

INSTALLATION:
Copy all of the files above into the example/fps/server/scripts directory.  
Please note that this OVERWRITES the original game.cs as a game object system 
has to run at the core of the script engine to work effectively.


ADVANTAGES OF GAME TYPE OBJECT ARCHITECTURE
- standard functions are available to all game type objects whilst being easily
  altered or overwritten using object-oriented code.
- Script is a lot cleaner as all functions, variables, schedules, etc, etc that 
  are associated with the game object is totally destroyed at the end of each 
  mission
- Game types can very easily be created using this method as 99% of the code 
  is already create in the DefaultGame
  
  
GAME OBJECT HEIRACHY
Most TGE users would be familiar with the heirachy of the player object
eg.	GameBase->ShapeBase->Player
and the game object is along the same lines

	ScriptObject->DefaultGame Object-> Game Object
	
From this model it should be easily seen that any DefaultGame function would 
be available to the game object but, using object inheritance, can be altered
or even overwritten by the Game Object.


HOW IT WORKS
The most important piece of code for this can be found in defaultGame.cs at 
approx line 62-72.  Going through the code we are doing the following:
	Line 64-66 - 	Determine the mission code to load from the mission file
	Line 67-71 - 	Create the game object with superclass of defaultGame
	Line 72	-	Activate the game package (if applicable)
At the end of each mission, the game package is deactivated and the game object,
including all its functions, schedules, variables are deleted.


DMGame and CTFGame are sample game code files (they dont actually do anything though)
and show some of the features of using this system such as:

DMGame::startGame 	- 	This function shows how to load the defaultGame::startGame 
				function AND add code to the end of it for the DM gametype.
DMGame::initGameVars 	- 	This function shows how to overwrite the 
				defaultGame::initGameVars function
DMGame::onMissionLoaded - 	This function shows how to load the 
				defaultGame::onMissionLoaded function AFTER DM game changes

onLeaveMissionArea	-	This shows how to use the GameType packaging that is also 
				part of the system
				

HOW DO I SET UP MISSIONS FOR THIS SYSTEM
Very very easily.  Just simply alter the MissionInfo object of the mission to include 
the mission type.  Here is an example on the Scorched Planet mission.
   new ScriptObject(MissionInfo) {
         name = "Scorched Planet";
         gametype = "CTF";
         descLines = "2";
         desc0 = "Wide open spaces and huge pyramids dominate this scorched planet.";
   };

Edit: ResetMission and endMission functions altered to destroy game object code.