Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/util/loading/game_loader.cc @ 7616

Last change on this file since 7616 was 7374, checked in by bensch, 19 years ago

orxonox/trunk: added new Files shell_completion_plugin for the new Plugin Structure.
Also created the first namespace: OrxShell

File size: 7.6 KB
RevLine 
[2636]1
2
[4597]3/*
[2636]4   orxonox - the future of 3D-vertical-scrollers
5
6   Copyright (C) 2004 orx
7
8   This program is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2, or (at your option)
11   any later version.
12
13   ### File Specific:
14   main-programmer: Patrick Boenzli
15   co-programmer: ...
16*/
17
[5300]18#define DEBUG_SPECIAL_MODULE DEBUG_MODULE_LOAD
19
[2636]20#include "game_loader.h"
[7193]21#include "util/loading/load_param.h"
[5139]22
23#include "shell_command.h"
[2636]24#include "campaign.h"
[6152]25
[7193]26#include "util/loading/resource_manager.h"
[6152]27
[4410]28#include "event_handler.h"
[2636]29
30
[7374]31namespace OrxShell
32{
[2636]33
[7374]34  SHELL_COMMAND(quit, GameLoader, stop)
35  ->describe("quits the game")
36  ->setAlias("orxoquit");
[2636]37
38
[7374]39  GameLoader* GameLoader::singletonRef = NULL;
[5162]40
41
[7374]42  /**
43   *  simple constructor
44   */
45  GameLoader::GameLoader ()
46  {
47    this->setClassID(CL_GAME_LOADER, "GameLoader");
48    this->setName("GameLoader");
49    this->bRun = true;
50  }
[5162]51
[2636]52
[7374]53  /**
54   *  simple deconstructor
55   */
56  GameLoader::~GameLoader ()
57  {
58    if( this->currentCampaign)
59      delete this->currentCampaign;
60    this->currentCampaign = NULL;
61  }
[2636]62
63
[7374]64  /**
65   *  initializes the GameLoader
66   */
67  ErrorMessage GameLoader::init()
68  {
69    if(this->currentCampaign != NULL)
70      this->currentCampaign->init();
[2636]71
[7374]72    this->eventHandler = EventHandler::getInstance();
73    this->eventHandler->subscribe(this, ES_GAME, KeyMapper::PEV_PAUSE);
74    this->eventHandler->subscribe(this, ES_ALL, EV_MAIN_QUIT);          //< External Quit Event
75    this->eventHandler->subscribe(this, ES_GAME, KeyMapper::PEV_QUIT);
76    this->eventHandler->subscribe(this, ES_GAME, KeyMapper::PEV_NEXT_WORLD);
77    this->eventHandler->subscribe(this, ES_GAME, KeyMapper::PEV_PREVIOUS_WORLD);
78  }
[4411]79
[2636]80
[7374]81  /**
82   *  reads a campaign definition file into a campaign class
83   * @param fileName to be loaded
84   * @returns the loaded campaign
85   *
86   * this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
87   */
88  ErrorMessage GameLoader::loadCampaign(const std::string& fileName)
89  {
90    ErrorMessage errorCode;
91    std::string campaignName = ResourceManager::getFullName(fileName);
92    if (!campaignName.empty())
[4094]93    {
94      this->currentCampaign = this->fileToCampaign(campaignName);
95    }
[7374]96  }
[2636]97
[6139]98
[7374]99  /**
100   *  reads a campaign definition file into a campaign class
101   * @param fileName to be loaded
102   * @returns the loaded campaign
103   *
104   * this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
105   */
106  ErrorMessage GameLoader::loadNetworkCampaign(const std::string& fileName)
[6139]107  {
[7374]108    ErrorMessage errorCode;
109    std::string campaignName = ResourceManager::getFullName(fileName);
110    if (!campaignName.empty())
111    {
112      this->currentCampaign = this->fileToCampaign(campaignName);
113    }
[6139]114  }
115
116
[7374]117  /**
118   *  loads a debug campaign for test purposes only.
119   * @param campaignID the identifier of the campaign.
120   * @returns error message if not able to do so.
121   */
122  ErrorMessage GameLoader::loadDebugCampaign(Uint32 campaignID)
123  {
124    switch(campaignID)
[2636]125    {
[7374]126        /*
127           Debug Level 0: Debug level used to test the base frame work.
128           As you can see, all storyentity data is allocated before game
129           start. the storyentity will load themselfs shortly before start
130           through the StoryEntity::init() funtion.
131        */
132      case DEBUG_CAMPAIGN_0:
133        {
134          /*        Campaign* debugCampaign = new Campaign();
[3220]135
[7374]136                  World* world0 = new World(DEBUG_WORLD_0);
137                  world0->setNextStoryID(WORLD_ID_1);
138                  debugCampaign->addEntity(world0, WORLD_ID_0);
[3220]139
[7374]140                  World* world1 = new World(DEBUG_WORLD_1);
141                  world1->setNextStoryID(WORLD_ID_2);
142                  debugCampaign->addEntity(world1, WORLD_ID_1);
[2636]143
[7374]144                  World* world2 = new World(DEBUG_WORLD_2);
145                  world2->setNextStoryID(WORLD_ID_GAMEEND);
146                  debugCampaign->addEntity(world2, WORLD_ID_2);
[3727]147
[7374]148                  this->currentCampaign = debugCampaign;
149                  break;*/
150        }
[2636]151    }
[7374]152  }
[2636]153
[4443]154
[7374]155  /**
156   *  starts the current entity
157   * @returns error code if this action has caused a error
158   */
159  ErrorMessage GameLoader::start()
[6862]160  {
[7374]161    if(this->currentCampaign != NULL)
162    {
163      this->currentCampaign->start();
164    }
[6862]165  }
[2636]166
167
[7374]168  /**
169   *  stops the current entity
170   * @returns error code if this action has caused a error
171   *
172   *  ATTENTION: this function shouldn't call other functions, or if so, they must return
173   *  after finishing. If you ignore or forget to do so, the current entity is not able to
174   *  terminate and it will run in the background or the ressources can't be freed or even
175   *  worse: are freed and the program will end in a segmentation fault!
176   *  hehehe, have ya seen it... :)
177   */
178  void GameLoader::stop()
179  {
180    if(this->currentCampaign != NULL)
181      this->currentCampaign->stop();
182  }
[2636]183
184
[7374]185  /**
186   *  pause the current entity
187   * @returns error code if this action has caused a error
188   *
189   * this pauses the current entity or passes this call forth to the running entity.
190   */
191  ErrorMessage GameLoader::pause()
192  {
193    this->isPaused = true;
194    if(this->currentCampaign != NULL)
195      this->currentCampaign->pause();
196  }
[2636]197
198
[7374]199  /**
200   *  resumes a pause
201   * @returns error code if this action has caused a error
202   *
203   *  this resumess the current entity or passes this call forth to the running entity.
204   */
205  ErrorMessage GameLoader::resume()
206  {
207    this->isPaused = false;
208    if(this->currentCampaign != NULL)
209      this->currentCampaign->resume();
210  }
[2636]211
[4443]212
[7374]213  /**
214   *  reads a campaign definition file into a campaign class
215   * @param fileName to be loaded
216   * @returns the loaded campaign
217   *
218   * this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
219   */
220  Campaign* GameLoader::fileToCampaign(const std::string& fileName)
221  {
222    /* do not entirely load the campaign. just the current world
223       before start of each world, it has to be initialized so it
224       can load everything it needs into memory then.
225    */
[4597]226
[7374]227    if( fileName.empty())
[4010]228    {
[4113]229      PRINTF(2)("No filename specified for loading");
[4010]230      return NULL;
231    }
[4597]232
[7374]233    TiXmlDocument XMLDoc(fileName);
234    // load the campaign document
235    if( !XMLDoc.LoadFile(fileName))
[4010]236    {
237      // report an error
[7221]238      PRINTF(1)("Could not load XML File %s: %s @ %d:%d\n", fileName.c_str(), XMLDoc.ErrorDesc(), XMLDoc.ErrorRow(), XMLDoc.ErrorCol());
[4010]239      return NULL;
240    }
[4597]241
[7374]242    // check basic validity
243    TiXmlElement* root = XMLDoc.RootElement();
244    assert( root != NULL);
[4597]245
[7374]246    if( strcmp( root->Value(), "Campaign"))
[4010]247    {
248      // report an error
[4113]249      PRINTF(2)("Specified XML File is not an orxonox campaign file (Campaign element missing)\n");
[4010]250      return NULL;
251    }
[4597]252
[7374]253    // construct campaign
254    return new Campaign( root);
255  }
[2636]256
257
[6139]258
[7374]259  /**
260   *  handle keyboard commands
261   * @param event the event to handle
262   */
263  void GameLoader::process(const Event& event)
[5553]264  {
[7374]265    if( event.type == KeyMapper::PEV_NEXT_WORLD)
[4410]266    {
[7374]267      if( likely(event.bPressed))
268      {
269        this->switchToNextLevel();
270      }
[4410]271    }
[7374]272    else if( event.type == KeyMapper::PEV_PAUSE)
[4410]273    {
[7374]274      if( likely(event.bPressed))
275      {
276        if(this->isPaused)
277          this->resume();
278        else
279          this->pause();
280      }
[4410]281    }
[7374]282    else if( event.type == KeyMapper::PEV_QUIT)
283    {
284      if( event.bPressed) this->stop();
285    }
286    else if (event.type == EV_MAIN_QUIT)
287      this->stop();
[5553]288  }
[7374]289
290
291  /**
292   *  this changes to the next level
293   */
294  void GameLoader::switchToNextLevel()
[5553]295  {
[7374]296    if(this->currentCampaign != NULL)
297      this->currentCampaign->switchToNextLevel();
[5553]298  }
[4410]299
[2636]300}
Note: See TracBrowser for help on using the repository browser.