0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation for my last commit.

Browse source
This commit is contained in:
Mark de Wever 2009-01-24 17:38:46 +00:00
parent 88675c4465
commit 9e7d0ca379
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/game_events.cpp
View file

@ -2832,6 +2832,14 @@ unit_map::iterator handle_speaker(
return speaker;
}
/**
* Helper to handle the image part of the message.
*
* @param cfg cfg of message.
* @param speaker The speaker of the message.
*
* @returns The image to show.
*/
std::string get_image(const vconfig& cfg, unit_map::iterator speaker)
{
std::string image = cfg["image"];
@ -2849,6 +2857,14 @@ std::string get_image(const vconfig& cfg, unit_map::iterator speaker)
return image;
}
/**
* Helper to handle the caption part of the message.
*
* @param cfg cfg of message.
* @param speaker The speaker of the message.
*
* @returns The caption to show.
*/
std::string get_caption(const vconfig& cfg, unit_map::iterator speaker)
{
std::string caption = cfg["caption"];