intro.hpp

Go to the documentation of this file.
00001 /* $Id: intro.hpp 23842 2008-02-16 08:47:16Z mordante $ */
00002 /*
00003    Copyright (C) 2003 - 2008 by David White <dave@whitevine.net>
00004    Part of the Battle for Wesnoth Project http://www.wesnoth.org/
00005 
00006    This program is free software; you can redistribute it and/or modify
00007    it under the terms of the GNU General Public License version 2
00008    or at your option any later version.
00009    This program is distributed in the hope that it will be useful,
00010    but WITHOUT ANY WARRANTY.
00011 
00012    See the COPYING file for more details.
00013 */
00014 
00015 //! @file intro.hpp 
00016 //!
00017 
00018 #ifndef INTRO_HPP_INCLUDED
00019 #define INTRO_HPP_INCLUDED
00020 
00021 class config;
00022 class display;
00023 #include "SDL.h"
00024 
00025 #include <string>
00026 
00027 //function to show an introduction sequence specified by data.
00028 //the format of data is like,
00029 //[part]
00030 //id='id'
00031 //story='story'
00032 //image='img'
00033 //[/part]
00034 //where 'id' is a unique identifier, 'story' is text describing
00035 //storyline, and 'img' is an image.
00036 //
00037 //each part of the sequence will be displayed in turn, with the
00038 //user able to go to the next part, or skip it entirely.
00039 void show_intro(display &disp, const config& data, const config& level);
00040 
00041 void the_end(display &disp);
00042 
00043 #endif

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs