games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-24 22:14:36 +02:00
Code Issues Releases Activity

Merge pull request #4566 from Laserlicht/outro_support

Browse Source 
Campaign outro
This commit is contained in:
Ivan Savenko 2024-09-12 14:20:56 +03:00 committed by GitHub
commit a9c4683da6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 77 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
client/CServerHandler.cpp
View File

@ -21,7 +21,11 @@
#include "globalLobby/GlobalLobbyClient.h"
#include "lobby/CSelectionBase.h"
#include "lobby/CLobbyScreen.h"
#include "lobby/CBonusSelection.h"
#include "windows/InfoWindows.h"
#include "media/CMusicHandler.h"
#include "media/IVideoPlayer.h"
#include "mainmenu/CMainMenu.h"
#include "mainmenu/CPrologEpilogVideo.h"
@ -704,7 +708,15 @@ void CServerHandler::startCampaignScenario(HighScoreParameter param, std::shared
else
{
CMM->openCampaignScreen(ourCampaign->campaignSet);
GH.windows().createAndPushWindow<CHighScoreInputScreen>(true, *campaignScoreCalculator, statistic);
if(!ourCampaign->getOutroVideo().empty() && CCS->videoh->open(ourCampaign->getOutroVideo(), false))
{
CCS->musich->stopMusic();
GH.windows().createAndPushWindow<CampaignRimVideo>(ourCampaign->getOutroVideo(), ourCampaign->getVideoRim().empty() ? ImagePath::builtin("INTRORIM") : ourCampaign->getVideoRim(), [campaignScoreCalculator, statistic](){
GH.windows().createAndPushWindow<CHighScoreInputScreen>(true, *campaignScoreCalculator, statistic);
});
}
else
GH.windows().createAndPushWindow<CHighScoreInputScreen>(true, *campaignScoreCalculator, statistic);
}
};

18
client/NetPacksLobbyClient.cpp
View File

@ -31,6 +31,8 @@
#include "gui/WindowHandler.h"
#include "widgets/Buttons.h"
#include "widgets/TextControls.h"
#include "media/CMusicHandler.h"
#include "media/IVideoPlayer.h"
#include "../lib/CConfigHandler.h"
#include "../lib/texts/CGeneralTextHandler.h"
@ -203,11 +205,19 @@ void ApplyOnLobbyScreenNetPackVisitor::visitLobbyUpdateState(LobbyUpdateState &
if(!lobby->bonusSel && handler.si->campState && handler.getState() == EClientState::LOBBY_CAMPAIGN)
{
lobby->bonusSel = std::make_shared<CBonusSelection>();
if(!handler.si->campState->conqueredScenarios().size() && !handler.si->campState->getIntroVideo().empty())
GH.windows().createAndPushWindow<CampaignIntroVideo>(handler.si->campState->getIntroVideo(), handler.si->campState->getIntroVideoRim().empty() ? ImagePath::builtin("INTRORIM") : handler.si->campState->getIntroVideoRim(), lobby->bonusSel);
auto bonusSel = std::make_shared<CBonusSelection>();
lobby->bonusSel = bonusSel;
if(!handler.si->campState->conqueredScenarios().size() && !handler.si->campState->getIntroVideo().empty() && CCS->videoh->open(handler.si->campState->getIntroVideo(), false))
{
CCS->musich->stopMusic();
GH.windows().createAndPushWindow<CampaignRimVideo>(handler.si->campState->getIntroVideo(), handler.si->campState->getVideoRim().empty() ? ImagePath::builtin("INTRORIM") : handler.si->campState->getVideoRim(), [bonusSel](){
if(!CSH->si->campState->getMusic().empty())
CCS->musich->playMusic(CSH->si->campState->getMusic(), true, false);
GH.windows().pushWindow(bonusSel);
});
}
else
GH.windows().pushWindow(lobby->bonusSel);
GH.windows().pushWindow(bonusSel);
}
if(lobby->bonusSel)

19
client/lobby/CBonusSelection.cpp
View File

@ -59,8 +59,8 @@
#include "../../lib/mapObjects/CGHeroInstance.h"
CampaignIntroVideo::CampaignIntroVideo(VideoPath video, ImagePath rim, std::shared_ptr<CBonusSelection> bonusSel)
: CWindowObject(BORDERED), bonusSel(bonusSel)
CampaignRimVideo::CampaignRimVideo(VideoPath video, ImagePath rim, std::function<void()> closeCb)
: CWindowObject(BORDERED), closeCb(closeCb)
{
OBJECT_CONSTRUCTION;
@ -70,26 +70,21 @@ CampaignIntroVideo::CampaignIntroVideo(VideoPath video, ImagePath rim, std::shar
videoPlayer = std::make_shared<VideoWidgetOnce>(Point(80, 186), video, true, [this](){ exit(); });
setBackground(rim);
CCS->musich->stopMusic();
}
void CampaignIntroVideo::exit()
void CampaignRimVideo::exit()
{
close();
if (!CSH->si->campState->getMusic().empty())
CCS->musich->playMusic(CSH->si->campState->getMusic(), true, false);
GH.windows().pushWindow(bonusSel);
if(closeCb)
closeCb();
}
void CampaignIntroVideo::clickPressed(const Point & cursorPosition)
void CampaignRimVideo::clickPressed(const Point & cursorPosition)
{
exit();
}
void CampaignIntroVideo::keyPressed(EShortcut key)
void CampaignRimVideo::keyPressed(EShortcut key)
{
exit();
}

7
client/lobby/CBonusSelection.h
View File

@ -33,14 +33,15 @@ class VideoWidgetOnce;
class CBonusSelection;
class CampaignIntroVideo : public CWindowObject
class CampaignRimVideo : public CWindowObject
{
std::shared_ptr<VideoWidgetOnce> videoPlayer;
std::shared_ptr<CBonusSelection> bonusSel;
std::function<void()> closeCb;
void exit();
public:
CampaignIntroVideo(VideoPath video, ImagePath rim, std::shared_ptr<CBonusSelection> bonusSel);
CampaignRimVideo(VideoPath video, ImagePath rim, std::function<void()> closeCb);
void clickPressed(const Point & cursorPosition) override;
void keyPressed(EShortcut key) override;

23
config/campaignOverrides.json
View File

@ -1,4 +1,11 @@
{
"DATA/GOOD3" : { // RoE - "Song for the Father"
"outroVideo": "Endgame"
},
"DATA/AB" : { // AB Intro
"introVideo": "H3X1intr",
"videoRim": "IntroRm2"
},
"MAPS/HC1_MAIN" : { // Heroes Chronicles 1
"regions":
{
@ -29,7 +36,7 @@
{ "voiceProlog": "chronicles_1/H3X2BBF", "voiceEpilog": "chronicles_1/N1C_D" }
],
"loadingBackground": "chronicles_1/LoadBar",
"introVideoRim": "chronicles_1/INTRORIM",
"videoRim": "chronicles_1/INTRORIM",
"introVideo": "chronicles_1/Intro"
},
"MAPS/HC2_MAIN" : { // Heroes Chronicles 2
@ -62,7 +69,7 @@
{ "voiceProlog": "chronicles_2/G1A", "voiceEpilog": "chronicles_2/S1C" }
],
"loadingBackground": "chronicles_2/LoadBar",
"introVideoRim": "chronicles_2/INTRORIM",
"videoRim": "chronicles_2/INTRORIM",
"introVideo": "chronicles_2/Intro"
},
"MAPS/HC3_MAIN" : { // Heroes Chronicles 3
@ -95,7 +102,7 @@
{ "voiceProlog": "chronicles_3/G3B", "voiceEpilog": "chronicles_3/ABVOFL2" }
],
"loadingBackground": "chronicles_3/LoadBar",
"introVideoRim": "chronicles_3/INTRORIM",
"videoRim": "chronicles_3/INTRORIM",
"introVideo": "chronicles_3/Intro"
},
"MAPS/HC4_MAIN" : { // Heroes Chronicles 4
@ -128,7 +135,7 @@
{ "voiceProlog": "chronicles_4/H3X2NBD", "voiceEpilog": "chronicles_4/S1C" }
],
"loadingBackground": "chronicles_4/LoadBar",
"introVideoRim": "chronicles_4/INTRORIM",
"videoRim": "chronicles_4/INTRORIM",
"introVideo": "chronicles_4/Intro"
},
"MAPS/HC5_MAIN" : { // Heroes Chronicles 5
@ -155,7 +162,7 @@
{ "voiceProlog": "chronicles_5/H3X2UAH", "voiceEpilog": "chronicles_5/N1C_D" }
],
"loadingBackground": "chronicles_5/LoadBar",
"introVideoRim": "chronicles_5/INTRORIM",
"videoRim": "chronicles_5/INTRORIM",
"introVideo": "chronicles_5/Intro"
},
"MAPS/HC6_MAIN" : { // Heroes Chronicles 6
@ -182,7 +189,7 @@
{ "voiceProlog": "chronicles_6/ABVOAB5", "voiceEpilog": "chronicles_6/ABVODB2" }
],
"loadingBackground": "chronicles_6/LoadBar",
"introVideoRim": "chronicles_6/INTRORIM",
"videoRim": "chronicles_6/INTRORIM",
"introVideo": "chronicles_6/Intro"
},
"MAPS/HC7_MAIN" : { // Heroes Chronicles 7
@ -215,7 +222,7 @@
{ "voiceProlog": "chronicles_7/ABVOFW4", "voiceEpilog": "chronicles_7/ABVOAB1" }
],
"loadingBackground": "chronicles_7/LoadBar",
"introVideoRim": "chronicles_7/INTRORIM",
"videoRim": "chronicles_7/INTRORIM",
"introVideo": "chronicles_7/Intro5"
},
"MAPS/HC8_MAIN" : { // Heroes Chronicles 8
@ -248,7 +255,7 @@
{ "voiceProlog": "chronicles_8/H3X2ELE", "voiceEpilog": "chronicles_8/ABVOAB7" }
],
"loadingBackground": "chronicles_8/LoadBar",
"introVideoRim": "chronicles_8/INTRORIM",
"videoRim": "chronicles_8/INTRORIM",
"introVideo": "chronicles_8/Intro6"
}
}

3
docs/modders/Campaign_Format.md
View File

@ -54,7 +54,8 @@ In header are parameters describing campaign properties
- `"allowDifficultySelection"` is a boolean field (`true`/`false`) which allows or disallows to choose difficulty before scenario start
- `"loadingBackground"` is for setting a different loading screen background
- `"introVideo"` is for defining an optional intro video
- `"introVideoRim"` is for the Rim around the optional video (default is INTRORIM)
- `"outroVideo"` is for defining an optional outro video
- `"videoRim"` is for the Rim around the optional video (default is INTRORIM)
## Scenario description

3
lib/campaign/CampaignHandler.cpp
View File

@ -169,8 +169,9 @@ void CampaignHandler::readHeaderFromJson(CampaignHeader & ret, JsonNode & reader
ret.modName = modName;
ret.encoding = encoding;
ret.loadingBackground = ImagePath::fromJson(reader["loadingBackground"]);
ret.introVideoRim = ImagePath::fromJson(reader["introVideoRim"]);
ret.videoRim = ImagePath::fromJson(reader["videoRim"]);
ret.introVideo = VideoPath::fromJson(reader["introVideo"]);
ret.outroVideo = VideoPath::fromJson(reader["outroVideo"]);
}
CampaignScenario CampaignHandler::readScenarioFromJson(JsonNode & reader)

15
lib/campaign/CampaignState.cpp
View File

@ -210,9 +210,9 @@ ImagePath CampaignHeader::getLoadingBackground() const
return loadingBackground;
}
ImagePath CampaignHeader::getIntroVideoRim() const
ImagePath CampaignHeader::getVideoRim() const
{
return introVideoRim;
return videoRim;
}
VideoPath CampaignHeader::getIntroVideo() const
@ -220,6 +220,11 @@ VideoPath CampaignHeader::getIntroVideo() const
return introVideo;
}
VideoPath CampaignHeader::getOutroVideo() const
{
return outroVideo;
}
const CampaignRegions & CampaignHeader::getRegions() const
{
return campaignRegions;
@ -490,10 +495,12 @@ void Campaign::overrideCampaign()
loadLegacyData(CampaignRegions::fromJson(entry.second["regions"]), entry.second["scenarioCount"].Integer());
if(!entry.second["loadingBackground"].isNull())
loadingBackground = ImagePath::builtin(entry.second["loadingBackground"].String());
if(!entry.second["introVideoRim"].isNull())
introVideoRim = ImagePath::builtin(entry.second["introVideoRim"].String());
if(!entry.second["videoRim"].isNull())
videoRim = ImagePath::builtin(entry.second["videoRim"].String());
if(!entry.second["introVideo"].isNull())
introVideo = VideoPath::builtin(entry.second["introVideo"].String());
if(!entry.second["outroVideo"].isNull())
outroVideo = VideoPath::builtin(entry.second["outroVideo"].String());
}
}

10
lib/campaign/CampaignState.h
View File

@ -98,8 +98,9 @@ class DLL_LINKAGE CampaignHeader : public boost::noncopyable
std::string modName;
std::string encoding;
ImagePath loadingBackground;
ImagePath introVideoRim;
ImagePath videoRim;
VideoPath introVideo;
VideoPath outroVideo;
int numberOfScenarios = 0;
bool difficultyChosenByPlayer = false;
@ -124,8 +125,9 @@ public:
std::string getEncoding() const;
AudioPath getMusic() const;
ImagePath getLoadingBackground() const;
ImagePath getIntroVideoRim() const;
ImagePath getVideoRim() const;
VideoPath getIntroVideo() const;
VideoPath getOutroVideo() const;
const CampaignRegions & getRegions() const;
TextContainerRegistrable & getTexts();
@ -153,9 +155,11 @@ public:
if (h.version >= Handler::Version::CHRONICLES_SUPPORT)
{
h & loadingBackground;
h & introVideoRim;
h & videoRim;
h & introVideo;
}
if (h.version >= Handler::Version::CAMPAIGN_OUTRO_SUPPORT)
h & outroVideo;
}
};

3
lib/serializer/ESerializationVersion.h
View File

@ -58,6 +58,7 @@ enum class ESerializationVersion : int32_t
SAVE_COMPATIBILITY_FIXES, // 859 - implementation of previoulsy postponed changes to serialization
CHRONICLES_SUPPORT, // 860 - support for heroes chronicles
PER_MAP_GAME_SETTINGS, // 861 - game settings are now stored per-map
CAMPAIGN_OUTRO_SUPPORT, // 862 - support for campaign outro video
CURRENT = PER_MAP_GAME_SETTINGS
CURRENT = CAMPAIGN_OUTRO_SUPPORT
};