mirror of
https://github.com/wesnoth/wesnoth
synced 2025-05-08 21:38:41 +00:00
aa6b0a82b7
* It is disabled at runtime unless the (purposefully undocumented) switch --shadowm-storyscreen is passed to the game's command line. * Doxygen.
62 lines
1.6 KiB
C++
62 lines
1.6 KiB
C++
/* $Id$ */
|
|
/*
|
|
Copyright (C) 2003 - 2009 by David White <dave@whitevine.net>
|
|
Part of the Battle for Wesnoth Project http://www.wesnoth.org/
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License version 2
|
|
or at your option any later version.
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY.
|
|
|
|
See the COPYING file for more details.
|
|
*/
|
|
|
|
/** @file intro.hpp */
|
|
|
|
#ifndef INTRO_HPP_INCLUDED
|
|
#define INTRO_HPP_INCLUDED
|
|
|
|
class config;
|
|
class vconfig;
|
|
class display;
|
|
#include "SDL.h"
|
|
|
|
#include <string>
|
|
|
|
/**
|
|
* Function to show an introduction sequence using story WML.
|
|
* The WML config data has a format similar to:
|
|
* @code
|
|
* [part]
|
|
* id='id'
|
|
* story='story'
|
|
* image='img'
|
|
* [/part]
|
|
* @endcode
|
|
* Where 'id' is a unique identifier, 'story' is text describing the
|
|
* storyline,and 'img' is a background image. Each part of the sequence will
|
|
* be displayed in turn, with the user able to go to the next part, or skip
|
|
* it entirely.
|
|
*/
|
|
void show_intro(display &disp, const vconfig& data, const config& level);
|
|
|
|
/**
|
|
* Displays a simple fading screen with any user-provided text.
|
|
* Used after the end of single-player campaigns.
|
|
*
|
|
* @param text Text to display, centered on the screen.
|
|
*
|
|
* @param duration In milliseconds, for how much time the text will
|
|
* be displayed on screen.
|
|
*/
|
|
void the_end(display &disp, std::string text, unsigned int duration);
|
|
|
|
/**
|
|
* Enables/disables the new (work in progress) story screen
|
|
* code.
|
|
*/
|
|
void set_new_storyscreen(bool enabled);
|
|
|
|
#endif /* ! INTRO_HPP_INCLUDED */
|