Logo Search packages:      
Sourcecode: scummvm version File versions  Download package


/* ScummVM - Scumm Interpreter
 * Copyright (C) 2002-2005 The ScummVM project
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * $Header: /cvsroot/scummvm/scummvm/base/engine.h,v 2005/10/18 02:11:17 sev Exp $

#ifndef ENGINE_H
#define ENGINE_H
#include "common/stdafx.h"
#include "common/scummsys.h"
#include "common/str.h"

class GameDetector;
class OSystem;
namespace Audio {
      class Mixer;
namespace Common {
      class SaveFileManager;
      class Timer;

class Engine {
      OSystem *_system;
      Audio::Mixer *_mixer;
      Common::Timer * _timer;

      const Common::String _gameDataPath;
      Common::SaveFileManager *_saveFileMan;

      Engine(OSystem *syst);
      virtual ~Engine();

       * Init the engine.
       * @return 0 for success, else an error code.
      virtual int init(GameDetector &detector) = 0;

       * Start the main engine loop.
       * The return value is not yet used, but could indicate whether the user
       * wants to return to the launch or to fully quit ScummVM.
       * @return a result code
      virtual int go() = 0;

      /** Get the path to the game data directory. */
      virtual const char *getGameDataPath() const;

      /** Specific for each engine: prepare error string. */
      virtual void errorString(const char *buf_input, char *buf_output) = 0;

      void initCommonGFX(GameDetector &detector);

      /** On some systems, check if the game appears to be run from CD. */
      void checkCD();

extern Engine *g_engine;


Generated by  Doxygen 1.6.0   Back to index