storyscreen/interface.hpp File Reference

Storyscreen controller (wrapper interface). More...

#include <string>
#include "config.hpp"

Include dependency graph for interface.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	storyscreen
Enumerations
enum	storyscreen::START_POSITION { storyscreen::START_BEGINNING, storyscreen::START_END }
Functions
void	show_story (display &disp, const std::string &scenario_name, const config::const_child_itors &story)
	Function to show an introduction sequence segment using story WML.
void	show_endscreen (display &disp, const t_string &text, unsigned int duration)
	Displays a simple fading screen with any user-provided text.

---

Detailed Description

Storyscreen controller (wrapper interface).

Definition in file interface.hpp.

---

Function Documentation

void show_endscreen	(	display &	disp,
		const t_string &	text,
		unsigned int	duration
	)

Displays a simple fading screen with any user-provided text.

Used after the end of single-player campaigns.

Parameters:

	text	Text to display, centered on the screen.
	duration	In milliseconds, for how much time the text will be displayed on screen.

Definition at line 92 of file interface.cpp.

References LOG_NG, and STUB.

Referenced by the_end().

Here is the caller graph for this function:

void show_story	(	display &	disp,
		const std::string &	scenario_name,
		const config::const_child_itors &	story
	)

Function to show an introduction sequence segment using story WML.

The WML config data (story_cfg) has a format similar to:

 [part]
     id='id'
     story='story'
     image='img'
 [/part]

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.

Returns:

is NEXT if the segment played to the end, BACK if the segment played to the beginning, and QUIT if the story was quit

Definition at line 57 of file interface.cpp.

References storyscreen::BACK, storyscreen::NEXT, storyscreen::QUIT, and storyscreen::controller::show().

Referenced by playsingle_controller::play_scenario().

Here is the call graph for this function:

Here is the caller graph for this function: