OpenClonk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
C4ScenarioListLoader::Scenario Class Reference

#include <C4StartupScenSelDlg.h>

Inheritance diagram for C4ScenarioListLoader::Scenario:
[legend]
Collaboration diagram for C4ScenarioListLoader::Scenario:
[legend]

Public Member Functions

 Scenario (class C4ScenarioListLoader *pLoader, class Folder *pParent)
 
 ~Scenario () override=default
 
bool LoadCustom (C4Group &rGrp, bool fNameLoaded, bool fIconLoaded) override
 
bool LoadCustomPre (C4Group &rGrp) override
 
bool Start () override
 
bool CanOpen (StdStrBuf &sError) override
 
bool IsGrayed () override
 
bool IsHidden () override
 
bool HasMissionAccess () const override
 
StdStrBuf GetOpenText () override
 
StdStrBuf GetOpenTooltip () override
 
const C4ScenarioGetC4S () const
 
bool GetAchievement (int32_t idx, C4Facet *out_facet, const char **out_description) override
 
StdStrBuf GetTypeName () override
 
const char * GetDefaultExtension () override
 
C4ScenarioParameterDefsGetParameterDefs () override
 
C4ScenarioParametersGetParameters () override
 
bool IsScenario () override
 
bool Load (C4Group *pFromGrp, const StdStrBuf *psFilename, bool fLoadEx)
 
virtual FolderGetIsFolder ()
 
const StdStrBufGetName () const
 
const StdStrBufGetEntryFilename () const
 
const StdStrBufGetVersion () const
 
const StdStrBufGetAuthor () const
 
const C4FacetGetIconFacet () const
 
const C4FacetGetTitlePicture () const
 
const StdStrBufGetDesc () const
 
int GetIconIndex ()
 
int GetDifficulty ()
 
int GetFolderIndex ()
 
EntryGetNext () const
 
class FolderGetParent () const
 
virtual bool HasUnregisteredAccess () const
 
virtual bool SetTitleInGroup (C4Group &rGrp, const char *szNewTitle)
 
bool RenameTo (const char *szNewName)
 

Static Public Member Functions

static EntryCreateEntryForFile (const StdStrBuf &sFilename, C4ScenarioListLoader *pLoader, Folder *pParent)
 

Protected Attributes

class C4ScenarioListLoaderpLoader
 
EntrypNext
 
class FolderpParent
 
StdCopyStrBuf sName
 
StdCopyStrBuf sFilename
 
StdCopyStrBuf sDesc
 
StdCopyStrBuf sVersion
 
StdCopyStrBuf sAuthor
 
C4FacetSurface fctIcon
 
C4FacetSurface fctTitle
 
bool fBaseLoaded
 
bool fExLoaded
 
int iIconIndex
 
int iDifficulty
 
int iFolderIndex
 

Detailed Description

Definition at line 109 of file C4StartupScenSelDlg.h.

Constructor & Destructor Documentation

C4ScenarioListLoader::Scenario::Scenario ( class C4ScenarioListLoader pLoader,
class Folder pParent 
)
inline

Definition at line 122 of file C4StartupScenSelDlg.h.

122 : Entry(pLoader, pParent), fNoMissionAccess(false), nAchievements(0), iMinPlrCount(0) {}
Entry(class C4ScenarioListLoader *pLoader, class Folder *pParent)
class C4ScenarioListLoader * pLoader
class Folder * pParent
C4ScenarioListLoader::Scenario::~Scenario ( )
overridedefault

Member Function Documentation

bool C4ScenarioListLoader::Scenario::CanOpen ( StdStrBuf sError)
overridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 759 of file C4StartupScenSelDlg.cpp.

References Config, StdStrBuf::Copy(), StdStrBuf::Format(), C4Config::General, C4StartupScenSelDlg::IsNetworkStart(), LoadResStr(), C4ConfigGeneral::Participants, C4StartupScenSelDlg::pInstance, and SModuleCount().

760 {
761  // safety
763  if (!pDlg) return false;
764  // check mission access
765  if (!HasMissionAccess())
766  {
767  sErrOut.Copy(LoadResStr("IDS_PRC_NOMISSIONACCESS"));
768  return false;
769  }
770  // replay
771  if (C4S.Head.Replay)
772  {
773  // replays can currently not be launched in network mode
774  if (pDlg->IsNetworkStart())
775  {
776  sErrOut.Copy(LoadResStr("IDS_PRC_NONETREPLAY"));
777  return false;
778  }
779  }
780  // regular game
781  else
782  {
783  // check player count
784  int32_t iPlrCount = SModuleCount(Config.General.Participants);
785  int32_t iMaxPlrCount = C4S.Head.MaxPlayer;
786  if (C4S.Head.SaveGame)
787  {
788  // Some scenarios have adjusted MaxPlayerCount to 0 after starting to prevent future joins
789  // make sure it's possible to start the savegame anyway
790  iMaxPlrCount = std::max<int32_t>(iMinPlrCount, iMaxPlrCount);
791  }
792  // normal scenarios: At least one player except in network mode, where it is possible to wait for the additional players
793  // Melees need at least two
794  if ((iPlrCount < iMinPlrCount))
795  {
796  if (pDlg->IsNetworkStart())
797  {
798  // network game: Players may yet join in lobby
799  // only issue a warning for too few players (by setting the error but not returning false here)
800  sErrOut.Format(LoadResStr("IDS_MSG_TOOFEWPLAYERSNET"), (int) iMinPlrCount);
801  }
802  else
803  {
804  // for regular games, this is a fatal no-start-cause
805  sErrOut.Format(LoadResStr("IDS_MSG_TOOFEWPLAYERS"), (int) iMinPlrCount);
806  return false;
807  }
808  }
809  // scenarios (both normal and savegame) may also impose a maximum player restriction
810  if (iPlrCount > iMaxPlrCount)
811  {
812  sErrOut.Format(LoadResStr("IDS_MSG_TOOMANYPLAYERS"), (int) C4S.Head.MaxPlayer);
813  return false;
814  }
815  }
816  // Okay, start!
817  return true;
818 }
C4Config Config
Definition: C4Config.cpp:833
C4ConfigGeneral General
Definition: C4Config.h:251
bool Replay
Definition: C4Scenario.h:72
const char * LoadResStr(const char *id)
Definition: C4Language.h:83
bool SaveGame
Definition: C4Scenario.h:71
char Participants[CFG_MaxString+1]
Definition: C4Config.h:38
int32_t MaxPlayer
Definition: C4Scenario.h:70
int SModuleCount(const char *szList)
Definition: Standard.cpp:589
bool HasMissionAccess() const override
bool IsNetworkStart() const
C4SHead Head
Definition: C4Scenario.h:230
static C4StartupScenSelDlg * pInstance

Here is the call graph for this function:

C4ScenarioListLoader::Entry * C4ScenarioListLoader::Entry::CreateEntryForFile ( const StdStrBuf sFilename,
C4ScenarioListLoader pLoader,
Folder pParent 
)
staticinherited

Definition at line 544 of file C4StartupScenSelDlg.cpp.

References C4CFN_FolderFiles, C4CFN_ScenarioFiles, DirContainsScenarios(), DirectoryExists(), StdStrBuf::getData(), GetExtension(), and WildcardMatch().

Referenced by C4ScenarioListLoader::SubFolder::DoLoadContents(), and C4ScenarioListLoader::RegularFolder::DoLoadContents().

545 {
546  // determine entry type by file type
547  const char *szFilename = sFilename.getData();
548  if (!szFilename || !*szFilename) return nullptr;
549  if (WildcardMatch(C4CFN_ScenarioFiles, sFilename.getData())) return new Scenario(pLoader, pParent);
550  if (WildcardMatch(C4CFN_FolderFiles, sFilename.getData())) return new SubFolder(pLoader, pParent);
551  // regular, open folder (C4Group-packed folders without extensions are not regarded, because they could contain anything!)
552  const char *szExt = GetExtension(szFilename);
553  if ((!szExt || !*szExt) && DirectoryExists(sFilename.getData()))
554  {
555  // open folders only if they contain a scenario or folder
556  if (DirContainsScenarios(szFilename))
557  return new RegularFolder(pLoader, pParent);
558  }
559  // type not recognized
560  return nullptr;
561 }
const char * getData() const
Definition: StdBuf.h:442
#define C4CFN_FolderFiles
Definition: C4Components.h:175
bool DirContainsScenarios(const char *szDir)
char * GetExtension(char *szFilename)
Definition: StdFile.cpp:121
bool DirectoryExists(const char *szFilename)
Definition: StdFile.cpp:684
bool WildcardMatch(const char *szWildcard, const char *szString)
Definition: StdFile.cpp:374
#define C4CFN_ScenarioFiles
Definition: C4Components.h:174
class Folder * pParent

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4ScenarioListLoader::Scenario::GetAchievement ( int32_t  idx,
C4Facet out_facet,
const char **  out_description 
)
overridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 743 of file C4StartupScenSelDlg.cpp.

744 {
745  // return true and fill output parameters if player got the indexed achievement
746  if (idx < 0 || idx >= nAchievements) return false;
747  *out_facet = fctAchievements[idx];
748  *out_description = sAchievementDescriptions[idx].getData();
749  return true;
750 }
const char * getData() const
Definition: StdBuf.h:442
const StdStrBuf& C4ScenarioListLoader::Entry::GetAuthor ( ) const
inlineinherited

Definition at line 77 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::sAuthor.

77 { return sAuthor; }
StdCopyStrBuf sAuthor
const C4Scenario& C4ScenarioListLoader::Scenario::GetC4S ( ) const
inline

Definition at line 135 of file C4StartupScenSelDlg.h.

Referenced by C4StartupScenSelDlg::StartScenario().

135 { return C4S; } // get scenario core

Here is the caller graph for this function:

const char* C4ScenarioListLoader::Scenario::GetDefaultExtension ( )
inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 140 of file C4StartupScenSelDlg.h.

140 { return "ocs"; }
const StdStrBuf& C4ScenarioListLoader::Entry::GetDesc ( ) const
inlineinherited

Definition at line 80 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::sDesc.

80 { return sDesc; }
StdCopyStrBuf sDesc
int C4ScenarioListLoader::Entry::GetDifficulty ( )
inlineinherited

Definition at line 82 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::iDifficulty.

Referenced by EntrySortFunc().

Here is the caller graph for this function:

const StdStrBuf& C4ScenarioListLoader::Entry::GetEntryFilename ( ) const
inlineinherited

Definition at line 75 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::sFilename.

Referenced by C4StartupScenSelDlg::DeleteConfirm(), C4StartupScenSelDlg::KeyDelete(), and C4StartupScenSelDlg::StartScenario().

75 { return sFilename; }
StdCopyStrBuf sFilename

Here is the caller graph for this function:

int C4ScenarioListLoader::Entry::GetFolderIndex ( )
inlineinherited

Definition at line 83 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::iFolderIndex.

Referenced by EntrySortFunc().

Here is the caller graph for this function:

const C4Facet& C4ScenarioListLoader::Entry::GetIconFacet ( ) const
inlineinherited

Definition at line 78 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::fctIcon.

Referenced by C4StartupScenSelDlg::ScenListItem::ScenListItem().

78 { return fctIcon; }
C4FacetSurface fctIcon

Here is the caller graph for this function:

int C4ScenarioListLoader::Entry::GetIconIndex ( )
inlineinherited

Definition at line 81 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::iIconIndex.

Referenced by EntrySortFunc().

Here is the caller graph for this function:

virtual Folder* C4ScenarioListLoader::Entry::GetIsFolder ( )
inlinevirtualinherited

Reimplemented in C4ScenarioListLoader::Folder.

Definition at line 72 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Folder::ClearChildren(), and EntrySortFunc().

72 { return nullptr; } // return this if this is a folder

Here is the caller graph for this function:

const StdStrBuf& C4ScenarioListLoader::Entry::GetName ( ) const
inlineinherited

Definition at line 74 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::sName.

Referenced by EntrySortFunc(), C4StartupScenSelDlg::KeyDelete(), and C4StartupScenSelDlg::ScenListItem::ScenListItem().

74 { return sName; }
StdCopyStrBuf sName

Here is the caller graph for this function:

Entry* C4ScenarioListLoader::Entry::GetNext ( ) const
inlineinherited

Definition at line 84 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::pNext.

Referenced by C4ScenarioListLoader::Folder::FindEntryByName().

84 { return pNext; }
Entry * pNext

Here is the caller graph for this function:

StdStrBuf C4ScenarioListLoader::Scenario::GetOpenText ( )
overridevirtual

Implements C4ScenarioListLoader::Entry.

Definition at line 820 of file C4StartupScenSelDlg.cpp.

References LoadResStr().

821 {
822  return StdCopyStrBuf(LoadResStr("IDS_BTN_STARTGAME"));
823 }
const char * LoadResStr(const char *id)
Definition: C4Language.h:83

Here is the call graph for this function:

StdStrBuf C4ScenarioListLoader::Scenario::GetOpenTooltip ( )
overridevirtual

Implements C4ScenarioListLoader::Entry.

Definition at line 825 of file C4StartupScenSelDlg.cpp.

References LoadResStr().

826 {
827  return StdCopyStrBuf(LoadResStr("IDS_DLGTIP_SCENSELNEXT"));
828 }
const char * LoadResStr(const char *id)
Definition: C4Language.h:83

Here is the call graph for this function:

C4ScenarioParameterDefs* C4ScenarioListLoader::Scenario::GetParameterDefs ( )
inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 142 of file C4StartupScenSelDlg.h.

142 { return &ParameterDefs; }
C4ScenarioParameters* C4ScenarioListLoader::Scenario::GetParameters ( )
inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 143 of file C4StartupScenSelDlg.h.

Referenced by C4StartupScenSelDlg::StartScenario().

143 { return &Parameters; }

Here is the caller graph for this function:

class Folder* C4ScenarioListLoader::Entry::GetParent ( ) const
inlineinherited

Definition at line 85 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::pParent.

Referenced by C4ScenarioListLoader::FolderBack().

85 { return pParent; }
class Folder * pParent

Here is the caller graph for this function:

const C4Facet& C4ScenarioListLoader::Entry::GetTitlePicture ( ) const
inlineinherited

Definition at line 79 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::fctTitle.

79 { return fctTitle; }
C4FacetSurface fctTitle
StdStrBuf C4ScenarioListLoader::Scenario::GetTypeName ( )
inlineoverridevirtual

Implements C4ScenarioListLoader::Entry.

Definition at line 138 of file C4StartupScenSelDlg.h.

References LoadResStr().

138 { return StdCopyStrBuf(LoadResStr("IDS_TYPE_SCENARIO"), true); }
const char * LoadResStr(const char *id)
Definition: C4Language.h:83

Here is the call graph for this function:

const StdStrBuf& C4ScenarioListLoader::Entry::GetVersion ( ) const
inlineinherited

Definition at line 76 of file C4StartupScenSelDlg.h.

References C4ScenarioListLoader::Entry::sVersion.

76 { return sVersion; }
StdCopyStrBuf sVersion
bool C4ScenarioListLoader::Scenario::HasMissionAccess ( ) const
inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 132 of file C4StartupScenSelDlg.h.

Referenced by IsHidden().

132 { return !fNoMissionAccess; }; // check mission access only

Here is the caller graph for this function:

virtual bool C4ScenarioListLoader::Entry::HasUnregisteredAccess ( ) const
inlinevirtualinherited

Definition at line 95 of file C4StartupScenSelDlg.h.

95 { return false; }
bool C4ScenarioListLoader::Scenario::IsGrayed ( )
inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 130 of file C4StartupScenSelDlg.h.

130 { return false; } // additional option for graying out
bool C4ScenarioListLoader::Scenario::IsHidden ( )
inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 131 of file C4StartupScenSelDlg.h.

References HasMissionAccess(), C4Scenario::Head, and C4SHead::Secret.

131 { return C4S.Head.Secret && !HasMissionAccess(); } // condition for hiding element completely
bool HasMissionAccess() const override
bool Secret
Definition: C4Scenario.h:77
C4SHead Head
Definition: C4Scenario.h:230

Here is the call graph for this function:

bool C4ScenarioListLoader::Scenario::IsScenario ( )
inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 145 of file C4StartupScenSelDlg.h.

145 { return true; }
bool C4ScenarioListLoader::Entry::Load ( C4Group pFromGrp,
const StdStrBuf psFilename,
bool  fLoadEx 
)
inherited

Definition at line 431 of file C4StartupScenSelDlg.cpp.

References C4CFN_IconPNG, C4CFN_ScenarioDesc, C4CFN_ScenarioIcon, C4CFN_ScenarioTitle, C4CFN_Title, C4CFN_Version, C4FCT_Full, C4StartupScenSel_DefaultIcon_OldIconBG, C4FacetSurface::Clear(), Config, C4Facet::Draw(), C4StartupGraphics::fctScenSelIcons, C4Group::FindEntry(), C4Config::General, C4Startup::Get(), C4ComponentHost::GetData(), StdStrBuf::getData(), GetFilename(), C4Group::GetFullName(), C4ComponentHost::GetLanguageString(), C4Facet::GetPhase(), C4Surface::GetPixDw(), C4Startup::Graphics, C4Facet::Hgt, C4ConfigGeneral::LanguageEx, C4ComponentHost::Load(), C4FacetSurface::Load(), C4Language::LoadComponentHost(), C4Group::LoadEntryString(), C4Surface::Lock(), C4Group::Open(), C4Group::OpenAsChild(), RemoveExtension(), C4Surface::SetPixDw(), C4Facet::Surface, C4Surface::Unlock(), and C4Facet::Wdt.

Referenced by C4ScenarioListLoader::SubFolder::DoLoadContents(), C4ScenarioListLoader::RegularFolder::DoLoadContents(), and C4ScenarioListLoader::LoadExtended().

432 {
433  // nothing to do if already loaded
434  if (fBaseLoaded && (fExLoaded || !fLoadEx)) return true;
435  C4Group Group;
436  // group specified: Load as child
437  if (pFromGrp)
438  {
439  assert(psFilename);
440  if (!Group.OpenAsChild(pFromGrp, psFilename->getData())) return false;
441  // set FN by complete entry name
442  this->sFilename.Take(Group.GetFullName());
443  }
444  else
445  {
446  // set FN by complete entry name
447  if (psFilename) this->sFilename.Copy(*psFilename);
448  // no parent group: Direct load from filename
449  if (!Group.Open(sFilename.getData())) return false;
450  }
451  // okay; load standard stuff from group
452  bool fNameLoaded=false, fIconLoaded=false;
453  if (fBaseLoaded)
454  {
455  fNameLoaded = fIconLoaded = true;
456  }
457  else
458  {
459  // Set default name as filename without extension
461  char *szBuf = sName.GrabPointer();
462  RemoveExtension(szBuf);
463  sName.Take(szBuf);
464  // load entry specific stuff that's in the front of the group
465  if (!LoadCustomPre(Group))
466  return false;
467  // Load entry name
468  C4ComponentHost DefNames;
471  fNameLoaded = true;
472  // load entry icon
473  if (Group.FindEntry(C4CFN_IconPNG) && fctIcon.Load(Group, C4CFN_IconPNG, C4FCT_Full, C4FCT_Full, false, 0))
474  fIconLoaded = true;
475  else
476  {
477  C4FacetSurface fctTemp;
478  if (Group.FindEntry(C4CFN_ScenarioIcon) && fctTemp.Load(Group, C4CFN_ScenarioIcon, C4FCT_Full, C4FCT_Full, true, 0))
479  {
480  // old style icon: Blit it on a pieace of paper
481  fctTemp.Surface->Lock();
482  for (int y=0; y<fctTemp.Hgt; ++y)
483  for (int x=0; x<fctTemp.Wdt; ++x)
484  {
485  uint32_t dwPix = fctTemp.Surface->GetPixDw(x,y, false);
486  // transparency has some tolerance...
487  if (Inside<uint8_t>(dwPix & 0xff, 0xb8, 0xff))
488  if (Inside<uint8_t>((dwPix>>0x08) & 0xff, 0x00, 0x0f))
489  if (Inside<uint8_t>((dwPix>>0x10) & 0xff, 0xb8, 0xff))
490  fctTemp.Surface->SetPixDw(x,y,0x00ffffff);
491  }
492  fctTemp.Surface->Unlock();
493  int iIconSize = C4Startup::Get()->Graphics.fctScenSelIcons.Hgt;
494  fctIcon.Create(iIconSize, iIconSize, C4FCT_Full, C4FCT_Full);
496  fctTemp.Draw(fctIcon.Surface, (fctIcon.Wdt-fctTemp.Wdt)/2, (fctIcon.Hgt-fctTemp.Hgt)/2);
497  fctTemp.Clear();
498  fIconLoaded = true;
499  }
500  }
501  // load any entryx-type-specific custom data (e.g. fallbacks for scenario title, and icon)
502  if (!LoadCustom(Group, fNameLoaded, fIconLoaded)) return false;
503  fBaseLoaded = true;
504  }
505  // load extended stuff: title picture
506  if (fLoadEx && !fExLoaded)
507  {
508  // load desc
509  C4ComponentHost DefDesc;
511  {
512  sDesc.Copy(DefDesc.GetData());
513  }
514  // load title
516  fExLoaded = true;
517  // load version
519  }
520  // done, success
521  return true;
522 }
char * GetFilename(char *szPath)
Definition: StdFile.cpp:45
const char * getData() const
Definition: StdBuf.h:442
bool FindEntry(const char *szWildCard, StdStrBuf *sFileName=nullptr, size_t *iSize=nullptr)
Definition: C4Group.cpp:1774
C4Config Config
Definition: C4Config.cpp:833
char * GrabPointer()
Definition: StdBuf.h:459
const int32_t C4StartupScenSel_DefaultIcon_OldIconBG
C4ConfigGeneral General
Definition: C4Config.h:251
bool Load(C4Group &hGroup, const char *szName, int iWdt, int iHgt, bool fNoErrIfNotFound, int iFlags)
Definition: C4FacetEx.cpp:78
const char * GetData() const
bool Lock()
Definition: C4Surface.cpp:453
bool Unlock()
Definition: C4Surface.cpp:464
#define C4CFN_Version
Definition: C4Components.h:72
StdCopyStrBuf sDesc
C4FacetID fctScenSelIcons
Definition: C4Startup.h:61
StdCopyStrBuf sName
StdCopyStrBuf sFilename
bool GetLanguageString(const char *szLanguage, StdStrBuf &rTarget)
static bool LoadComponentHost(C4ComponentHost *host, C4Group &hGroup, const char *szFilename, const char *szLanguage)
Definition: C4Language.cpp:232
#define C4CFN_Title
Definition: C4Components.h:82
StdCopyStrBuf sVersion
bool SetPixDw(int iX, int iY, DWORD dwCol)
Definition: C4Surface.cpp:576
StdStrBuf GetFullName() const
Definition: C4Group.cpp:2078
bool Open(const char *szGroupName, bool fCreate=false)
Definition: C4Group.cpp:514
virtual bool LoadCustom(C4Group &rGrp, bool fNameLoaded, bool fIconLoaded)
void Take(char *pnData)
Definition: StdBuf.h:457
void Draw(C4Facet &cgo, bool fAspect=true, int32_t iPhaseX=0, int32_t iPhaseY=0, bool fTransparent=true)
Definition: C4Facet.cpp:154
DWORD GetPixDw(int iX, int iY, bool fApplyModulation)
Definition: C4Surface.cpp:491
char LanguageEx[CFG_MaxString+1]
Definition: C4Config.h:37
void RemoveExtension(char *szFilename)
Definition: StdFile.cpp:306
C4FacetSurface fctIcon
bool fBaseLoaded
bool fExLoaded
bool LoadEntryString(const char *szEntryName, StdStrBuf *Buf)
Definition: C4Group.cpp:1932
#define C4CFN_IconPNG
Definition: C4Components.h:86
float Hgt
Definition: C4Facet.h:118
#define C4CFN_ScenarioDesc
Definition: C4Components.h:88
bool Create(int iWdt, int iHgt, int iWdt2=C4FCT_Full, int iHgt2=C4FCT_Full)
Definition: C4FacetEx.cpp:54
static C4Startup * Get()
Definition: C4Startup.h:133
C4Surface * Surface
Definition: C4Facet.h:117
const int C4FCT_Full
Definition: C4FacetEx.h:26
#define C4CFN_ScenarioIcon
Definition: C4Components.h:85
void Copy()
Definition: StdBuf.h:467
float Wdt
Definition: C4Facet.h:118
C4Facet GetPhase(int iPhaseX=0, int iPhaseY=0)
Definition: C4Facet.cpp:59
C4StartupGraphics Graphics
Definition: C4Startup.h:100
void Clear()
Definition: C4FacetEx.h:44
#define C4CFN_ScenarioTitle
Definition: C4Components.h:84
bool OpenAsChild(C4Group *pMother, const char *szEntryName, bool fExclusive=false, bool fCreate=false)
Definition: C4Group.cpp:1585
virtual bool LoadCustomPre(C4Group &rGrp)
C4FacetSurface fctTitle

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4ScenarioListLoader::Scenario::LoadCustom ( C4Group rGrp,
bool  fNameLoaded,
bool  fIconLoaded 
)
overridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 722 of file C4StartupScenSelDlg.cpp.

References C4Startup::Get().

723 {
724  // icon fallback: Standard scenario icon
725  if (!fIconLoaded)
726  {
727  iIconIndex = C4S.Head.Icon;
728  fctIcon.Set(C4Startup::Get()->Graphics.fctScenSelIcons.GetSection(C4S.Head.Icon));
729  }
730  // scenario name fallback to core
731  if (!fNameLoaded)
732  sName = C4S.Head.Title;
733  // difficulty: Set only for regular rounds (not savegame or record) to avoid bogus sorting
734  if (!C4S.Head.SaveGame && !C4S.Head.Replay)
736  else
737  iDifficulty = 0;
738  // minimum required player count
739  iMinPlrCount = C4S.GetMinPlayer();
740  return true;
741 }
int32_t Icon
Definition: C4Scenario.h:68
bool Replay
Definition: C4Scenario.h:72
std::string Title
Definition: C4Scenario.h:64
int32_t GetMinPlayer()
Definition: C4Scenario.cpp:141
void Set(const C4Facet &cpy)
Definition: C4FacetEx.h:46
StdCopyStrBuf sName
int iDifficulty
bool SaveGame
Definition: C4Scenario.h:71
int iIconIndex
C4FacetSurface fctIcon
static C4Startup * Get()
Definition: C4Startup.h:133
int32_t Difficulty
Definition: C4Scenario.h:67
C4SHead Head
Definition: C4Scenario.h:230

Here is the call graph for this function:

bool C4ScenarioListLoader::Scenario::LoadCustomPre ( C4Group rGrp)
overridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 657 of file C4StartupScenSelDlg.cpp.

References C4GraphicsResource::Achievements, C4ScenarioParameters::AddFilename2ID(), C4CFN_Achievements, C4CFN_AnyScriptStringTbl, C4CFN_ScenarioCore, C4CFN_ScenarioParameterDefs, C4CFN_ScriptStringTbl, C4FCT_Full, C4FCT_Height, C4StartupScenSel_MaxAchievements, Config, C4ScenarioParameterDef::Option::Description, DirSep, C4AchievementGraphics::FindByName(), C4Config::General, C4ScenarioParameterDef::GetAchievement(), StdStrBuf::getData(), C4ScenarioParameterDef::GetDefault(), C4Group::GetFullName(), C4ScenarioParameterDef::GetID(), C4ScenarioParameterDef::GetOptionByValue(), GraphicsResource, C4ScenarioParameterDef::IsAchievement(), C4ConfigGeneral::LanguageEx, C4ScenarioListLoader::Load(), C4Language::LoadComponentHost(), C4Group::LoadEntryString(), C4ConfigGeneral::MissionAccess, mkParAdapt(), C4Group::PreCacheEntries(), StdStrBuf::Replace(), C4FacetSurface::Set(), and SIsModule().

658 {
659  // load scenario core first
660  StdStrBuf sFileContents;
661  if (!rGrp.LoadEntryString(C4CFN_ScenarioCore, &sFileContents)) return false;
662  if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkParAdapt(C4S, false), sFileContents, (rGrp.GetFullName() + DirSep C4CFN_ScenarioCore).getData()))
663  return false;
664  // Mission access
665  fNoMissionAccess = (!C4S.Head.MissionAccess.empty() && !SIsModule(Config.General.MissionAccess, C4S.Head.MissionAccess.c_str()));
666  // Localized parameter definitions. needed for achievements and parameter input boxes.
667  // Only show them for "real" scenarios
668  if (!C4S.Head.SaveGame && !C4S.Head.Replay)
669  {
670  // Skipping ahead in regular reading list, so keep other entries in memory
673  C4LangStringTable ScenarioLangStringTable;
675  ParameterDefs.Load(rGrp, &ScenarioLangStringTable);
676  // achievement images: Loaded from this entry and parent folder
677  nAchievements = 0;
678  const C4ScenarioParameterDefs *deflists[] = { pParent ? pParent->GetAchievementDefs() : nullptr, &ParameterDefs };
679  for (auto deflist : deflists)
680  {
681  if (!deflist) continue;
682  const C4ScenarioParameterDef *def; size_t idx=0;
683  while ((def = deflist->GetParameterDefByIndex(idx++)))
684  {
685  if (def->IsAchievement())
686  {
687  int32_t val = pLoader->GetAchievements().GetValueByID(C4ScenarioParameters::AddFilename2ID(rGrp.GetFullName().getData(), def->GetID()).getData(), def->GetDefault());
688  if (val)
689  {
690  // player has this achievement - find graphics for it
691  const char *achievement_gfx = def->GetAchievement();
692  StdStrBuf sAchievementFilename(C4CFN_Achievements);
693  sAchievementFilename.Replace("*", achievement_gfx);
694  // look in scenario
695  if (!fctAchievements[nAchievements].Load(rGrp, sAchievementFilename.getData(), C4FCT_Height, C4FCT_Full, false, true))
696  {
697  // look in parent folder
698  const C4FacetSurface *fct = nullptr;
699  const C4AchievementGraphics *parent_achv_gfx;
700  if (pParent && (parent_achv_gfx = pParent->GetAchievementGfx())) fct = parent_achv_gfx->FindByName(achievement_gfx);
701  // look in main gfx group file
702  if (!fct) fct = ::GraphicsResource.Achievements.FindByName(achievement_gfx);
703  if (!fct) continue; // achievement graphics not found :(
704  fctAchievements[nAchievements].Set((const C4Facet &)*fct);
705  }
706  // section by achievement index (1-based, since zero means no achievement)
707  if (val>1) fctAchievements[nAchievements].X += fctAchievements[nAchievements].Wdt * (val-1);
708  // description for this achievement is taken from option
709  const C4ScenarioParameterDef::Option *opt = def->GetOptionByValue(val);
710  if (opt) sAchievementDescriptions[nAchievements] = opt->Description;
711  // keep track of achievement count
712  ++nAchievements;
713  if (nAchievements == C4StartupScenSel_MaxAchievements) break;
714  }
715  }
716  }
717  }
718  }
719  return true;
720 }
const char * getData() const
Definition: StdBuf.h:442
bool Load(C4Group &hGroup, class C4LangStringTable *pLang)
C4Config Config
Definition: C4Config.cpp:833
virtual const C4ScenarioParameterDefs * GetAchievementDefs() const
char MissionAccess[CFG_MaxString+1]
Definition: C4Config.h:45
std::string MissionAccess
Definition: C4Scenario.h:76
C4ConfigGeneral General
Definition: C4Config.h:251
bool Replay
Definition: C4Scenario.h:72
virtual const C4AchievementGraphics * GetAchievementGfx() const
const int C4FCT_Height
Definition: C4FacetEx.h:27
#define C4CFN_ScenarioParameterDefs
Definition: C4Components.h:43
bool SIsModule(const char *szList, const char *szString, int *ipIndex, bool fCaseSensitive)
Definition: Standard.cpp:519
C4GraphicsResource GraphicsResource
void Set(const C4Facet &cpy)
Definition: C4FacetEx.h:46
static StdStrBuf AddFilename2ID(const char *filename, const char *id)
#define C4CFN_ScriptStringTbl
Definition: C4Components.h:68
static bool LoadComponentHost(C4ComponentHost *host, C4Group &hGroup, const char *szFilename, const char *szLanguage)
Definition: C4Language.cpp:232
bool SaveGame
Definition: C4Scenario.h:71
StdStrBuf GetFullName() const
Definition: C4Group.cpp:2078
const char * GetID() const
char LanguageEx[CFG_MaxString+1]
Definition: C4Config.h:37
#define C4CFN_Achievements
Definition: C4Components.h:90
int PreCacheEntries(const char *szSearchPattern, bool cache_previous=false)
Definition: C4Group.cpp:2222
const Option * GetOptionByValue(int32_t val) const
bool LoadEntryString(const char *szEntryName, StdStrBuf *Buf)
Definition: C4Group.cpp:1932
#define C4CFN_ScenarioCore
Definition: C4Components.h:42
class C4ScenarioListLoader * pLoader
C4FacetSurface * FindByName(const char *name) const
C4AchievementGraphics Achievements
const char * GetAchievement() const
#define C4CFN_AnyScriptStringTbl
Definition: C4Components.h:69
StdParameterAdapt< T, P > mkParAdapt(T &&rObj, P &&rPar)
Definition: StdAdaptors.h:458
bool Load(C4Group *pFromGrp, const StdStrBuf *psFilename, bool fLoadEx)
C4SHead Head
Definition: C4Scenario.h:230
#define DirSep
const int32_t C4StartupScenSel_MaxAchievements
const int C4FCT_Full
Definition: C4FacetEx.h:26
float Wdt
Definition: C4Facet.h:118
float X
Definition: C4Facet.h:118
const C4ScenarioParameters & GetAchievements() const
class Folder * pParent
int32_t GetValueByID(const char *id, int32_t default_value) const

Here is the call graph for this function:

bool C4ScenarioListLoader::Entry::RenameTo ( const char *  szNewName)
inherited

Definition at line 563 of file C4StartupScenSelDlg.cpp.

References _MAX_PATH, C4GUI::MessageDialog::btnOK, C4CFN_Title, C4Group_IsGroup(), C4Group_MoveItem(), C4Group::Close(), C4Group::Delete(), StdStrBuf::Format(), StdStrBuf::getData(), C4Group::GetError(), GetFilename(), C4GUI::Ico_Error, ItemExists(), ItemIdentical(), LoadResStr(), MakeFilenameFromTitle(), C4Group::Open(), pGUI, SAppend(), SCopy(), SEqual(), and C4GUI::Screen::ShowMessageModal().

564 {
565  // change name+filename
566  // some name sanity validation
567  if (!szNewName || !*szNewName) return false;
568  if (SEqual(szNewName, sName.getData())) return true;
569  char fn[_MAX_PATH+1];
570  SCopy(szNewName, fn, _MAX_PATH);
571  // generate new file name
573  if (!*fn) return false;
574  const char *szExt = GetDefaultExtension();
575  if (szExt) { SAppend(".", fn, _MAX_PATH); SAppend(szExt, fn, _MAX_PATH); }
576  char fullfn[_MAX_PATH+1];
577  SCopy(sFilename.getData(), fullfn, _MAX_PATH);
578  char *fullfn_fn = GetFilename(fullfn);
579  SCopy(fn, fullfn_fn, _MAX_PATH - (fullfn_fn - fullfn));
580  StdCopyStrBuf strErr(LoadResStr("IDS_FAIL_RENAME"));
581  // check if a rename is due
582  if (!ItemIdentical(sFilename.getData(), fullfn))
583  {
584  // check for duplicate filename
585  if (ItemExists(fullfn))
586  {
587  StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_FILEEXISTS"), fullfn);
589  return false;
590  }
591  // OK; then rename
592  if (!C4Group_MoveItem(sFilename.getData(), fullfn, true))
593  {
594  StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_RENAMEFILE"), sFilename.getData(), fullfn);
596  return false;
597  }
598  sFilename.Copy(fullfn);
599  }
600  // update real name in group, if this is a group
601  if (C4Group_IsGroup(fullfn))
602  {
603  C4Group Grp;
604  if (!Grp.Open(fullfn))
605  {
606  StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_OPENFILE"), sFilename.getData(), Grp.GetError());
608  return false;
609  }
610  if (!Grp.Delete(C4CFN_Title))
611  {
612  StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_DELOLDTITLE"), sFilename.getData(), Grp.GetError());
614  return false;
615  }
616  if (!SetTitleInGroup(Grp, szNewName)) return false;
617  if (!Grp.Close())
618  {
619  StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_WRITENEWTITLE"), sFilename.getData(), Grp.GetError());
621  return false;
622  }
623  }
624  // update title
625  sName.Copy(szNewName);
626  // done
627  return true;
628 }
char * GetFilename(char *szPath)
Definition: StdFile.cpp:45
const char * getData() const
Definition: StdBuf.h:442
void SCopy(const char *szSource, char *sTarget, size_t iMaxL)
Definition: Standard.cpp:130
void SAppend(const char *szSource, char *szTarget, int iMaxL)
Definition: Standard.cpp:235
bool ItemIdentical(const char *szFilename1, const char *szFilename2)
Definition: StdFile.cpp:855
virtual const char * GetDefaultExtension()
void Format(const char *szFmt,...) GNUC_FORMAT_ATTRIBUTE_O
Definition: StdBuf.cpp:174
bool Delete(const char *szFiles, bool fRecursive=false)
Definition: C4Group.cpp:1334
#define _MAX_PATH
bool SEqual(const char *szStr1, const char *szStr2)
Definition: Standard.h:93
StdCopyStrBuf sName
StdCopyStrBuf sFilename
const char * LoadResStr(const char *id)
Definition: C4Language.h:83
void MakeFilenameFromTitle(char *szTitle)
Definition: StdFile.cpp:402
C4GUIScreen * pGUI
Definition: C4Gui.cpp:1191
#define C4CFN_Title
Definition: C4Components.h:82
bool ShowMessageModal(const char *szMessage, const char *szCaption, DWORD dwButtons, Icons icoIcon, int32_t *piConfigDontShowAgainSetting=nullptr)
bool Open(const char *szGroupName, bool fCreate=false)
Definition: C4Group.cpp:514
bool C4Group_IsGroup(const char *szFilename)
Definition: C4Group.cpp:94
bool Close()
Definition: C4Group.cpp:755
virtual bool SetTitleInGroup(C4Group &rGrp, const char *szNewTitle)
const char * GetError()
Definition: C4Group.cpp:504
bool C4Group_MoveItem(const char *szSource, const char *szTarget1, bool fNoSort)
Definition: C4Group.cpp:144
bool ItemExists(const char *szItemName)
Definition: StdFile.h:75
void Copy()
Definition: StdBuf.h:467

Here is the call graph for this function:

bool C4ScenarioListLoader::Entry::SetTitleInGroup ( C4Group rGrp,
const char *  szNewTitle 
)
virtualinherited

Definition at line 630 of file C4StartupScenSelDlg.cpp.

References C4Group::Add(), C4GUI::MessageDialog::btnOK, C4CFN_WriteTitle, Config, StdStrBuf::Copy(), StdStrBuf::Format(), C4Config::General, StdStrBuf::getData(), C4Group::GetError(), GetFilename(), StdStrBuf::GrabPointer(), C4GUI::Ico_Error, C4ConfigGeneral::Language, LoadResStr(), pGUI, RemoveExtension(), SEqual(), C4GUI::Screen::ShowMessageModal(), and StdStrBuf::Take().

631 {
632  // default for group files: Create a title text file and set the title in there
633  // no title needed if filename is sufficient - except for scenarios, where a Scenario.txt could overwrite the title
634  if (!IsScenario())
635  {
636  StdStrBuf sNameByFile; sNameByFile.Copy(GetFilename(sFilename.getData()));
637  char *szBuf = sNameByFile.GrabPointer();
638  RemoveExtension(szBuf);
639  sNameByFile.Take(szBuf);
640  if (SEqual(szNewTitle, sNameByFile.getData())) return true;
641  }
642  // okay, make a title
643  StdStrBuf sTitle; sTitle.Format("%s:%s", Config.General.Language, szNewTitle);
644  if (!rGrp.Add(C4CFN_WriteTitle, sTitle, false, true))
645  {
646  StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_ERRORADDINGNEWTITLEFORFIL"), sFilename.getData(), rGrp.GetError());
648  return false;
649  }
650  return true;
651 }
char * GetFilename(char *szPath)
Definition: StdFile.cpp:45
const char * getData() const
Definition: StdBuf.h:442
#define C4CFN_WriteTitle
Definition: C4Components.h:83
C4Config Config
Definition: C4Config.cpp:833
char * GrabPointer()
Definition: StdBuf.h:459
C4ConfigGeneral General
Definition: C4Config.h:251
void Format(const char *szFmt,...) GNUC_FORMAT_ATTRIBUTE_O
Definition: StdBuf.cpp:174
virtual bool IsScenario()
bool SEqual(const char *szStr1, const char *szStr2)
Definition: Standard.h:93
StdCopyStrBuf sFilename
const char * LoadResStr(const char *id)
Definition: C4Language.h:83
C4GUIScreen * pGUI
Definition: C4Gui.cpp:1191
bool ShowMessageModal(const char *szMessage, const char *szCaption, DWORD dwButtons, Icons icoIcon, int32_t *piConfigDontShowAgainSetting=nullptr)
void Take(char *pnData)
Definition: StdBuf.h:457
void RemoveExtension(char *szFilename)
Definition: StdFile.cpp:306
char Language[CFG_MaxString+1]
Definition: C4Config.h:36
const char * GetError()
Definition: C4Group.cpp:504
bool Add(const char *szFile, const char *szAddAs)
Definition: C4Group.cpp:1316
void Copy()
Definition: StdBuf.h:467

Here is the call graph for this function:

bool C4ScenarioListLoader::Scenario::Start ( )
overridevirtual

Implements C4ScenarioListLoader::Entry.

Definition at line 752 of file C4StartupScenSelDlg.cpp.

753 {
754  // gogo!
755  if (!(C4StartupScenSelDlg::pInstance)) return false;
756  return (C4StartupScenSelDlg::pInstance)->StartScenario(this);
757 }
static C4StartupScenSelDlg * pInstance

Member Data Documentation

bool C4ScenarioListLoader::Entry::fBaseLoaded
protectedinherited

Definition at line 59 of file C4StartupScenSelDlg.h.

C4FacetSurface C4ScenarioListLoader::Entry::fctIcon
protectedinherited

Definition at line 58 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::GetIconFacet().

C4FacetSurface C4ScenarioListLoader::Entry::fctTitle
protectedinherited

Definition at line 58 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::GetTitlePicture().

bool C4ScenarioListLoader::Entry::fExLoaded
protectedinherited

Definition at line 59 of file C4StartupScenSelDlg.h.

int C4ScenarioListLoader::Entry::iDifficulty
protectedinherited
int C4ScenarioListLoader::Entry::iFolderIndex
protectedinherited
int C4ScenarioListLoader::Entry::iIconIndex
protectedinherited
class C4ScenarioListLoader* C4ScenarioListLoader::Entry::pLoader
protectedinherited

Definition at line 50 of file C4StartupScenSelDlg.h.

class Folder* C4ScenarioListLoader::Entry::pParent
protectedinherited

Definition at line 52 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::GetParent().

StdCopyStrBuf C4ScenarioListLoader::Entry::sAuthor
protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::GetAuthor().

StdCopyStrBuf C4ScenarioListLoader::Entry::sDesc
protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::GetDesc().

StdCopyStrBuf C4ScenarioListLoader::Entry::sFilename
protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::GetEntryFilename().

StdCopyStrBuf C4ScenarioListLoader::Entry::sName
protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::GetName().

StdCopyStrBuf C4ScenarioListLoader::Entry::sVersion
protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::GetVersion().


The documentation for this class was generated from the following files: